Snapz AI

users

Patch One

Find One

conversations

{conversation_id}

Get Many

Post One

Delete Many

Usage

messages

Paginate

prompts

{prompt_id}

exports

Export User Queries

Export File Uploads

documents

Post Files

Document Usage

Get One

settings

Get Settings

Update Settings

integrations

contexts

{external_id}

Index

Default

Snapz API

<p class="slate-p " >The &apos;users&apos; section of the Snapz API allows users to retrieve detailed information about registered users within the platform. With this section, users can access key user data, such as profile details, preferences, and activity logs. This API section empowers developers to create personalized user experiences and tailor their applications based on individual user profiles.</p><p class="slate-p " ></p>

The 'users' section of the Snapz API allows users to retrieve detailed information about registered users within the platform. With this section, users can access key user data, such as profile details, preferences, and activity logs. This API section empowers developers to create personalized user experiences and tailor their applications based on individual user profiles.

The "Patch One" section of the Snapz API allows users to update specific user details, such as accepted terms, within their account. By utilizing this section, users can easily manage and modify user information to ensure accurate and up-to-date records. This functionality provides a seamless way for users to maintain their account information efficiently.

The acceptedTerms body parameter indicates whether the user has agreed to the terms and conditions specified. It helps in determining if the user has accepted the terms of service.

acceptedTerms

The Content-Type header parameter specifies the media type of the data sent to the server in the request. It indicates the format of the data being transmitted.

Content-Type

The Accept header parameter specifies the desired content type of the response from the server. It indicates what media type is acceptable for the response.

Accept

The Authorization header parameter provides credentials or tokens to authenticate the user's identity and permissions when accessing the API endpoint. It authorizes the user to interact with the specified resources.

Authorization

The id response parameter signifies the unique identifier associated with the data or resource. It is used for identifying and referencing the specific element within the system.

The clerkUserId response parameter represents the unique identifier for the user who is a clerk within the system. It is used to distinguish and identify individual clerk users.

clerkUserId

The organizationId response parameter denotes the unique identifier for the organization related to the user. It plays a significant role in managing and accessing organization-specific data.

organizationId

The clerkOrganizationId response parameter represents the unique identifier for the organization associated with the clerk. This ID is crucial for identifying the specific organization in the system.

clerkOrganizationId

The createdAt response parameter represents the timestamp indicating when the data or resource was created. It provides valuable information about the creation time of the specific resource.

createdAt

Successful Response

The detail response parameter provides additional detailed information related to the data returned in the response. It offers more context or specifics about the response data.

detail

Validation Error

The "Find One" section of the Snapz API allows users to retrieve detailed information about their own user profile. By making a request to this endpoint, users can access key details such as their unique ID, organization affiliation, acceptance of terms, and creation date. This section is essential for users looking to view and manage their personal account information within the Snapz platform.

Specifies the media type which is acceptable for the response. It should be set to "application/json".

Contains the credentials required to authenticate the user and authorize access to the API.

The unique identifier of the organization to which the user belongs.

The unique identifier of the clerk's organization associated with the user.

Indicates whether the user has accepted the terms and conditions.

The date and time when the user account was created.

The conversations section of the Snapz API allows users to retrieve and manage chat conversations between users. With this functionality, developers can access and manipulate the messages exchanged within a conversation, facilitating seamless communication between users within the Snapz platform.

The "messages" section of the Snapz API allows users to retrieve communication data related to a project. Users can access messages exchanged within the platform to track project updates, collaborate with team members, and stay informed about project progress. This section provides a central hub for managing project communication efficiently.

The 'prompts' section of the Snapz API provides a set of predefined prompts that users can utilize to engage with their audience more effectively. By accessing this section, users can enhance their content creation process by leveraging these prompts to inspire and spark creativity in their work. This feature enables users to easily generate engaging and interactive content for their target audience.

The "exports" section of the Snapz API allows users to retrieve data exports related to their account, providing a convenient way to access and download important information from the platform. With this functionality, users can easily gather and analyze data for reporting, integration with other systems, or backup purposes.

The "documents" section of the Snapz API allows users to access important files and information related to their projects. By utilizing this section, users can retrieve documents, contracts, and other necessary paperwork seamlessly through the API. This section provides easy access to essential project documentation, streamlining workflows and enhancing efficiency for users.

The "settings" section of the Snapz API allows users to manage and customize their account preferences and configurations. With this section, users can control notification settings, manage security options, and personalize their overall Snapz experience to suit their specific needs and preferences.

The integrations section of the Snapz API allows users to seamlessly connect with third-party services and tools to enhance their functionality. By leveraging this feature, developers can easily integrate Snapz with various platforms and applications, expanding the capabilities and reach of their projects. This section provides a straightforward way to establish integrations and streamline workflows, ultimately enhancing the overall user experience.

The Snapz API Index section provides a comprehensive overview of all available resources and endpoints within the Snapz API. Users can quickly access information on various functionalities and data structures supported by the API, facilitating seamless integration and development of applications using Snapz services.

The Accept header parameter specifies the media types that are acceptable for the response. It allows the client to specify the format in which it would like the server to return the response.

The "Post One" section of the Snapz API allows users to create a new context entry, enabling them to associate various parameters such as text, conversation ID, and external ID. By utilizing this endpoint, users can efficiently organize and manage their data within the Snapz platform to streamline workflows and enhance user experience.

The text body parameter contains the textual content for the request.

text

conversationId

externalId

documentId

messageId

The Content-Type header parameter specifies the media type of the request being sent.

The Accept header parameter specifies the media types that are acceptable for the response.

The Authorization header parameter contains the credentials required to authenticate the request.

The id response parameter represents the unique identifier associated with the request.

The userId response parameter specifies the unique identifier associated with a user.

userId

The createdAt response parameter represents the date and time when the resource was created.

The status response parameter indicates the status or outcome of the request.

status

The detail response parameter provides additional details or information about the response.

Sections