Create Completion

API Reference

Agents

Create a completion for an agent

client.agents.createCompletion(stringuuid, AgentCreateCompletionParamsbody, RequestOptionsoptions?): idstringcontentarraytype"response"intermediatary_resultsunknownrelated_searchesunionsourcesunionAgentCreateCompletionResponse

post/v1/agents/{UUID}/completions

Create a completion for an agent

Parameters

uuidstring

bodyenable_conversation_historybooleanmessagesarraystreambooleanenable_agent_clarification_questionsbooleanenable_editable_workflowbooleansourcesarraythread_iduniontoolsarrayuse_nested_youchat_updatesbooleanAgentCreateCompletionParams

Hide ParametersShow Parameters

enable_conversation_historyboolean

Enable conversation history

messagesarray

Array<Message>

Hide ParametersShow Parameters

contentunion

string | Array<MessageText | MessageImage>

Hide ParametersShow Parameters

string

Array<MessageText | MessageImage>

roleunion

"user" | "agent"

Hide ParametersShow Parameters

"user"

"agent"

streamboolean

Whether to stream the response using SSE

enable_agent_clarification_questionsboolean

optional

enable_editable_workflowboolean

optional

sourcesarray

optional

Array<type"url"urlstringSourceURL | file_uristringtype"file"SourceFile>

Hide ParametersShow Parameters

SourceURL

Hide ParametersShow Parameters

type"url"

Hide ParametersShow Parameters

"url"

urlstring

SourceFile

Hide ParametersShow Parameters

file_uristring

type"file"

Hide ParametersShow Parameters

"file"

thread_idunion

optional

string | null

Optional thread identifier

toolsarray

optional

Array<Tool>

Hide ParametersShow Parameters

search_additional_sourcesboolean

search_depthunion

"dynamic" | "quick" | "deep"

Hide ParametersShow Parameters

"dynamic"

"quick"

"deep"

type"web_search"

Hide ParametersShow Parameters

"web_search"

sitesunion

optional

Array<Site> | null

Hide ParametersShow Parameters

urlstring

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

use_nested_youchat_updatesboolean

optional

Returns

AgentCreateCompletionResponse

Hide ParametersShow Parameters

idstring

contentarray

Array<citationsarraytextstringtype"thinking"ContentThinking | textstringtype"text"citationsarrayContentText | pathstringtype"image"ContentImage>

Hide ParametersShow Parameters

ContentThinking

Hide ParametersShow Parameters

citationsarray

Array<idnumbertypeunionattributesRecord<string, unknown>uriunionCitation>

Hide ParametersShow Parameters

idnumber

typeunion

"file" | "url"

Hide ParametersShow Parameters

"file"

"url"

attributesRecord<string, unknown>

optional

uriunion

optional

string | null

textstring

type"thinking"

Hide ParametersShow Parameters

"thinking"

ContentText

Hide ParametersShow Parameters

textstring

type"text"

Hide ParametersShow Parameters

"text"

citationsarray

optional

Array<idnumbertypeunionattributesRecord<string, unknown>uriunionCitation>

Hide ParametersShow Parameters

idnumber

typeunion

"file" | "url"

Hide ParametersShow Parameters

"file"

"url"

attributesRecord<string, unknown>

optional

uriunion

optional

string | null

ContentImage

Hide ParametersShow Parameters

pathstring

type"image"

Hide ParametersShow Parameters

"image"

type"response"

Hide ParametersShow Parameters

"response"

intermediatary_resultsunknown

optional

Intermediate results (type unspecified)

related_searchesunion

optional

Array<RelatedSearch> | null

Hide ParametersShow Parameters

textstring

sourcesunion

optional

Array<snippetstringtitlestringtype"web"urlstringResponseSourceWeb | type"file"uristringResponseSourceFile> | null

Hide ParametersShow Parameters

ResponseSourceWeb

Hide ParametersShow Parameters

snippetstring

titlestring

type"web"

Hide ParametersShow Parameters

"web"

urlstring

ResponseSourceFile

Hide ParametersShow Parameters

type"file"

Hide ParametersShow Parameters

"file"

uristring

HTTPTypeScriptPython

import YouAPI from 'you-api';

const client = new YouAPI({
  bearerToken: 'My Bearer Token',
});

const response = await client.agents.createCompletion('UUID', {
  enable_conversation_history: true,
  messages: [{ content: 'string', role: 'user' }],
  stream: true,
});

console.log(response.id);

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"
    }
  ]
}