Create Completion

API Reference

Agents

Create a completion for an agent

post/v1/agents/{UUID}/completions

Create a completion for an agent

Path Parameters

UUIDstring

Body Parameters

enable_conversation_historyboolean

Enable conversation history

messagesarray of object

Hide ParametersShow Parameters

contentunion

string OR array of object OR object

Hide ParametersShow Parameters

UnionMember0string

UnionMember1array of union

Hide ParametersShow Parameters

MessageTextobject

Hide ParametersShow Parameters

textstring

typeenum

"text"

Hide ParametersShow Parameters

"text"

MessageImageobject

Hide ParametersShow Parameters

filestring

typeenum

"image"

Hide ParametersShow Parameters

"image"

roleenum

"user" OR "agent"

Hide ParametersShow Parameters

"user"

"agent"

streamboolean

Whether to stream the response using SSE

enable_agent_clarification_questionsboolean

optional

enable_editable_workflowboolean

optional

sourcesarray of union

optional

Hide ParametersShow Parameters

SourceURLobject

Hide ParametersShow Parameters

typeenum

"url"

Hide ParametersShow Parameters

"url"

urlstring

SourceFileobject

Hide ParametersShow Parameters

file_uristring

typeenum

"file"

Hide ParametersShow Parameters

"file"

thread_idstring

optional

Optional thread identifier

toolsarray of object

optional

Hide ParametersShow Parameters

search_additional_sourcesboolean

search_depthenum

"dynamic" OR "quick" OR "deep"

Hide ParametersShow Parameters

"dynamic"

"quick"

"deep"

typeenum

"web_search"

Hide ParametersShow Parameters

"web_search"

sitesarray of object

optional

Hide ParametersShow Parameters

urlstring

URL for inclusion or exclusion (prefix with '-' for exclusion)

use_nested_youchat_updatesboolean

optional

Returns

idstring

contentarray of union

Hide ParametersShow Parameters

ContentThinkingobject

Hide ParametersShow Parameters

citationsarray of idnumbertypeenumattributesmapuristringCitation

textstring

typeenum

"thinking"

Hide ParametersShow Parameters

"thinking"

ContentTextobject

Hide ParametersShow Parameters

textstring

typeenum

"text"

Hide ParametersShow Parameters

"text"

citationsarray of idnumbertypeenumattributesmapuristringCitation

optional

ContentImageobject

Hide ParametersShow Parameters

pathstring

typeenum

"image"

Hide ParametersShow Parameters

"image"

typeenum

"response"

Hide ParametersShow Parameters

"response"

intermediatary_resultsunknown

optional

Intermediate results (type unspecified)

related_searchesarray of object

optional

Hide ParametersShow Parameters

textstring

sourcesarray of union

optional

Hide ParametersShow Parameters

ResponseSourceWebobject

Hide ParametersShow Parameters

snippetstring

titlestring

typeenum

"web"

Hide ParametersShow Parameters

"web"

urlstring

ResponseSourceFileobject

Hide ParametersShow Parameters

typeenum

"file"

Hide ParametersShow Parameters

"file"

uristring

HTTPTypeScriptPython

curl https://api.you.com/v1/agents/$UUID/completions \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $YOU_API_API_KEY" \
    -d '{
      "enable_conversation_history": true,
      "messages": [
        {
          "content": "string",
          "role": "user"
        }
      ],
      "stream": true
    }'

200 Example

{
  "id": "id",
  "content": [
    {
      "citations": [
        {
          "id": 0,
          "type": "file",
          "attributes": {
            "foo": "bar"
          },
          "uri": "uri"
        }
      ],
      "text": "text",
      "type": "thinking"
    }
  ],
  "type": "response",
  "intermediatary_results": {},
  "related_searches": [
    {
      "text": "text"
    }
  ],
  "sources": [
    {
      "snippet": "snippet",
      "title": "title",
      "type": "web",
      "url": "url"
    }
  ]
}