Skip to main content
POST
/
v1
/
compile
/
documents
Submit Compile Document
curl --request POST \
  --url https://api.faces.sh/v1/compile/documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "<string>",
  "content": "<string>",
  "label": "<string>",
  "perspective": "first-person"
}
'
{
  "document_id": "<string>",
  "alias": "<string>",
  "label": "<string>",
  "source": "<string>",
  "version": 123,
  "content": "<string>",
  "token_count": 123,
  "tokens_used": 123,
  "tokens_limit": 123,
  "synced": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "prepare_status": "<string>",
  "chunks_total": 123,
  "chunks_completed": 123,
  "current_counts": {}
}

Headers

authorization
string | null

Body

application/json
alias
string
required
content
string
required
label
string | null
perspective
enum<string>
default:first-person
Available options:
first-person,
third-person

Response

Successful Response

Shared shape for submit, get, edit responses.

document_id
string
required
alias
string
required
label
string
required
source
string
required
version
integer
required
content
string
required
token_count
integer
required
tokens_used
integer
required
tokens_limit
integer
required
synced
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
prepare_status
string | null
chunks_total
integer | null
chunks_completed
integer | null
current_counts
Current Counts · object