Skip to main content
POST
/
chat
/
completions
Create chat completion
curl --request POST \
  --url https://app.generalcounsel.ai/api/external/v1/chat/completions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "What are the key terms to look for in a software license agreement?",
  "file_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "chat/completions",
  "status": "pending",
  "result": {
    "result": "When reviewing a software license agreement, key terms to examine include:\n\n1. **License Grant** - Understand the scope of rights granted..."
  },
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "created_at": "<string>",
  "completed_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gc.ai/llms.txt

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

Authorizations

​
Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → Organization → API Keys.

Headers

​
Prefer
string

Optional RFC 7240 wait preference, for example wait=0. If both this header and the wait query parameter are supplied, they must match.

Example:

"wait=0"

Query Parameters

​
wait
integer

Optional long-poll wait time in seconds. Use 0 for fire-and-forget behavior. If both wait and Prefer: wait=... are supplied, they must match. Values above 90 are clamped.

Required range: x >= 0
Example:

0

Body

application/json
​
message
string
required

The user's message or prompt

Minimum string length: 1
Example:

"What are the key terms to look for in a software license agreement?"

​
file_ids
string<uuid>[]

Optional uploaded file IDs to attach as context for this completion. Upload files first via POST /files.

Example:
["123e4567-e89b-12d3-a456-426614174000"]

Response

Job completed within the effective wait window

​
id
string<uuid>
required

Async job identifier

​
kind
enum<string>
required

Stable job kind for this endpoint

Available options:
chat/completions
​
status
enum<string>
required

Current job status

Available options:
pending,
running,
succeeded,
failed,
canceled
​
result
object
required

Completion payload when the job has succeeded

​
error
object
required

Failure payload when the job has failed

​
created_at
string
required

ISO 8601 creation timestamp

​
completed_at
string | null
required

ISO 8601 completion timestamp, or null when not terminal