Skip to main content
POST
/
api
/
v1
/
chats
Create chat
curl --request POST \
  --url https://app.sure.am/api/v1/chats \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "title": "Monthly budget review",
  "message": "<string>",
  "model": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "messages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "user_message",
      "role": "user",
      "content": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "model": "<string>",
      "tool_calls": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "function_name": "<string>",
          "function_arguments": {},
          "created_at": "2023-11-07T05:31:56Z",
          "function_result": {}
        }
      ]
    }
  ],
  "error": "The AI provider is rate limited right now. Please try again in a few minutes.",
  "pagination": {
    "page": 2,
    "per_page": 2,
    "total_count": 1,
    "total_pages": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://sure-917046f5-docs-backup-restore-clarity.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Body

application/json
​
title
string
required
Example:

"Monthly budget review"

​
message
string

Optional initial message in the chat

​
model
string

Optional OpenAI model identifier

Response

chat created

​
id
string<uuid>
required
​
title
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
messages
object[]
required
​
error
string | null

User-friendly error message describing the most recent failure of the assistant for this chat, or null when no error is present. Errors are classified into a small set of presentable messages so clients can display them directly without exposing raw provider details:

  • Rate limited — "The AI provider is rate limited right now. Please try again in a few minutes."
  • Temporarily unavailable — "The AI provider is temporarily unavailable right now. Please try again in a few minutes."
  • Misconfigured — "The AI provider is not configured correctly. Please contact your administrator."
  • Default fallback — "Failed to generate a response. Please try again." Successful chats always return null for this field.
Example:

"The AI provider is rate limited right now. Please try again in a few minutes."

​
pagination
object