Skip to content
You API SDK Docs
  • Auto
  • Light
  • Dark
Get An API Key

Create Completion

API Reference
Agents
Create a completion for an agent
agents.create_completion(struuid, AgentCreateCompletionParams**kwargs) -> idstrcontentlisttypeliteralintermediatary_resultsobjectrelated_searcheslistsourceslistAgentCreateCompletionResponse
post/v1/agents/{UUID}/completions

Create a completion for an agent

Parameters
uuidstr
enable_conversation_historybool

Enable conversation history

messagesiterable
contentunionroleliteralIterable[Message]
Hide ParametersShow Parameters
contentunion
Union[str, Iterable[MessageContentUnionMember1]]
Hide ParametersShow Parameters
MessageContentUnionMember0type
str
MessageContentUnionMember1type
Iterable[MessageContentUnionMember1]
Hide ParametersShow Parameters
MessageContentUnionMember1MessageTextclass
Hide ParametersShow Parameters
textstr
typeliteral
Literal["text"]
Hide ParametersShow Parameters
"text"
MessageContentUnionMember1MessageImageclass
Hide ParametersShow Parameters
filestr
typeliteral
Literal["image"]
Hide ParametersShow Parameters
"image"
roleliteral
Literal["user", "agent"]
Hide ParametersShow Parameters
"user"
"agent"
streambool

Whether to stream the response using SSE

enable_agent_clarification_questionsbool
optional
enable_editable_workflowbool
optional
sourcesiterable
optional
Iterable[Source]
Hide ParametersShow Parameters
SourceSourceURLclass
Hide ParametersShow Parameters
typeliteral
Literal["url"]
Hide ParametersShow Parameters
"url"
urlstr
SourceSourceFileclass
Hide ParametersShow Parameters
file_uristr
typeliteral
Literal["file"]
Hide ParametersShow Parameters
"file"
thread_idstr
optional

Optional thread identifier

toolsiterable
optional
search_additional_sourcesboolsearch_depthliteraltypeliteralsitesiterableIterable[Tool]
Hide ParametersShow Parameters
search_additional_sourcesbool
search_depthliteral
Literal["dynamic", "quick", "deep"]
Hide ParametersShow Parameters
"dynamic"
"quick"
"deep"
typeliteral
Literal["web_search"]
Hide ParametersShow Parameters
"web_search"
sitesiterable
optional
Optional[Iterable[ToolSite]]
Hide ParametersShow Parameters
urlstr

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

use_nested_youchat_updatesbool
optional
Returns
AgentCreateCompletionResponseclass
Hide ParametersShow Parameters
idstr
contentlist
List[Content]
Hide ParametersShow Parameters
ContentContentThinkingclass
Hide ParametersShow Parameters
citationslist
List[idinttypeliteralattributesDict[str, object]uristrCitation]
Hide ParametersShow Parameters
idint
typeliteral
Literal["file", "url"]
Hide ParametersShow Parameters
"file"
"url"
attributesDict[str, object]
optional
Optional[Dict[str, object]]
uristr
optional
textstr
typeliteral
Literal["thinking"]
Hide ParametersShow Parameters
"thinking"
ContentContentTextclass
Hide ParametersShow Parameters
textstr
typeliteral
Literal["text"]
Hide ParametersShow Parameters
"text"
citationslist
optional
Optional[List[idinttypeliteralattributesDict[str, object]uristrCitation]]
Hide ParametersShow Parameters
idint
typeliteral
Literal["file", "url"]
Hide ParametersShow Parameters
"file"
"url"
attributesDict[str, object]
optional
Optional[Dict[str, object]]
uristr
optional
ContentContentImageclass
Hide ParametersShow Parameters
pathstr
typeliteral
Literal["image"]
Hide ParametersShow Parameters
"image"
typeliteral
Literal["response"]
Hide ParametersShow Parameters
"response"
intermediatary_resultsobject
optional

Intermediate results (type unspecified)

sourceslist
optional
Optional[List[Source]]
Hide ParametersShow Parameters
SourceResponseSourceWebclass
Hide ParametersShow Parameters
snippetstr
titlestr
typeliteral
Literal["web"]
Hide ParametersShow Parameters
"web"
urlstr
SourceResponseSourceFileclass
Hide ParametersShow Parameters
typeliteral
Literal["file"]
Hide ParametersShow Parameters
"file"
uristr
from you_api import YouAPI

client = YouAPI(
    bearer_token="My Bearer Token",
)
response = client.agents.create_completion(
    uuid="UUID",
    enable_conversation_history=True,
    messages=[{
        "content": "string",
        "role": "user",
    }],
    stream=True,
)
print(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"
    }
  ]
}