Error
A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"metadata": {},
"project": "<string>",
"canonical_name": "<string>",
"about": "",
"model": "",
"instructions": [],
"default_settings": {},
"default_system_template": "{%- if agent.name -%}\nYou are {{agent.name}}.{{\" \"}}\n{%- endif -%}\n\n{%- if agent.about -%}\nAbout you: {{agent.about}}.{{\" \"}}\n{%- endif -%}\n\n{%- if user -%}\nYou are talking to a user\n {%- if user.name -%}{{\" \"}} and their name is {{user.name}}\n {%- if user.about -%}. About the user: {{user.about}}.{%- else -%}.{%- endif -%}\n {%- endif -%}\n{%- endif -%}\n\n{{NEWLINE}}\n\n{%- if session.situation -%}\nSituation: {{session.situation}}\n{%- endif -%}\n\n{{NEWLINE+NEWLINE}}\n\n{%- if agent.instructions -%}\nInstructions:{{NEWLINE}}\n {%- if agent.instructions is string -%}\n {{agent.instructions}}{{NEWLINE}}\n {%- else -%}\n {%- for instruction in agent.instructions -%}\n - {{instruction}}{{NEWLINE}}\n {%- endfor -%}\n {%- endif -%}\n {{NEWLINE}}\n{%- endif -%}\n\n{%- if docs -%}\nRelevant documents:{{NEWLINE}}\n {%- for doc in docs -%}\n {{doc.title}}{{NEWLINE}}\n {%- if doc.content is string -%}\n {{doc.content}}{{NEWLINE}}\n {%- else -%}\n {%- for snippet in doc.content -%}\n {{snippet}}{{NEWLINE}}\n {%- endfor -%}\n {%- endif -%}\n {{\"---\"}}\n {%- endfor -%}\n{%- endif -%}"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}agents
Create Agent
POST
/
agents
Error
A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"metadata": {},
"project": "<string>",
"canonical_name": "<string>",
"about": "",
"model": "",
"instructions": [],
"default_settings": {},
"default_system_template": "{%- if agent.name -%}\nYou are {{agent.name}}.{{\" \"}}\n{%- endif -%}\n\n{%- if agent.about -%}\nAbout you: {{agent.about}}.{{\" \"}}\n{%- endif -%}\n\n{%- if user -%}\nYou are talking to a user\n {%- if user.name -%}{{\" \"}} and their name is {{user.name}}\n {%- if user.about -%}. About the user: {{user.about}}.{%- else -%}.{%- endif -%}\n {%- endif -%}\n{%- endif -%}\n\n{{NEWLINE}}\n\n{%- if session.situation -%}\nSituation: {{session.situation}}\n{%- endif -%}\n\n{{NEWLINE+NEWLINE}}\n\n{%- if agent.instructions -%}\nInstructions:{{NEWLINE}}\n {%- if agent.instructions is string -%}\n {{agent.instructions}}{{NEWLINE}}\n {%- else -%}\n {%- for instruction in agent.instructions -%}\n - {{instruction}}{{NEWLINE}}\n {%- endfor -%}\n {%- endif -%}\n {{NEWLINE}}\n{%- endif -%}\n\n{%- if docs -%}\nRelevant documents:{{NEWLINE}}\n {%- for doc in docs -%}\n {{doc.title}}{{NEWLINE}}\n {%- if doc.content is string -%}\n {{doc.content}}{{NEWLINE}}\n {%- else -%}\n {%- for snippet in doc.content -%}\n {{snippet}}{{NEWLINE}}\n {%- endfor -%}\n {%- endif -%}\n {{\"---\"}}\n {%- endfor -%}\n{%- endif -%}"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Payload for creating a agent (and associated documents)
Required string length:
1 - 255Required string length:
1 - 255Pattern:
^[a-zA-Z][a-zA-Z0-9_]*$Required string length:
1 - 255Pattern:
^[a-zA-Z][a-zA-Z0-9_]*$default_system_template
string
default:{%- if agent.name -%}
You are {{agent.name}}.{{" "}}
{%- endif -%}
{%- if agent.about -%}
About you: {{agent.about}}.{{" "}}
{%- endif -%}
{%- if user -%}
You are talking to a user
{%- if user.name -%}{{" "}} and their name is {{user.name}}
{%- if user.about -%}. About the user: {{user.about}}.{%- else -%}.{%- endif -%}
{%- endif -%}
{%- endif -%}
{{NEWLINE}}
{%- if session.situation -%}
Situation: {{session.situation}}
{%- endif -%}
{{NEWLINE+NEWLINE}}
{%- if agent.instructions -%}
Instructions:{{NEWLINE}}
{%- if agent.instructions is string -%}
{{agent.instructions}}{{NEWLINE}}
{%- else -%}
{%- for instruction in agent.instructions -%}
- {{instruction}}{{NEWLINE}}
{%- endfor -%}
{%- endif -%}
{{NEWLINE}}
{%- endif -%}
{%- if docs -%}
Relevant documents:{{NEWLINE}}
{%- for doc in docs -%}
{{doc.title}}{{NEWLINE}}
{%- if doc.content is string -%}
{{doc.content}}{{NEWLINE}}
{%- else -%}
{%- for snippet in doc.content -%}
{{snippet}}{{NEWLINE}}
{%- endfor -%}
{%- endif -%}
{{"---"}}
{%- endfor -%}
{%- endif -%}
Response
Successful Response
Required string length:
1 - 255Required string length:
1 - 255Pattern:
^[a-zA-Z][a-zA-Z0-9_]*$Required string length:
1 - 255Pattern:
^[a-zA-Z][a-zA-Z0-9_]*$default_system_template
string
default:{%- if agent.name -%}
You are {{agent.name}}.{{" "}}
{%- endif -%}
{%- if agent.about -%}
About you: {{agent.about}}.{{" "}}
{%- endif -%}
{%- if user -%}
You are talking to a user
{%- if user.name -%}{{" "}} and their name is {{user.name}}
{%- if user.about -%}. About the user: {{user.about}}.{%- else -%}.{%- endif -%}
{%- endif -%}
{%- endif -%}
{{NEWLINE}}
{%- if session.situation -%}
Situation: {{session.situation}}
{%- endif -%}
{{NEWLINE+NEWLINE}}
{%- if agent.instructions -%}
Instructions:{{NEWLINE}}
{%- if agent.instructions is string -%}
{{agent.instructions}}{{NEWLINE}}
{%- else -%}
{%- for instruction in agent.instructions -%}
- {{instruction}}{{NEWLINE}}
{%- endfor -%}
{%- endif -%}
{{NEWLINE}}
{%- endif -%}
{%- if docs -%}
Relevant documents:{{NEWLINE}}
{%- for doc in docs -%}
{{doc.title}}{{NEWLINE}}
{%- if doc.content is string -%}
{{doc.content}}{{NEWLINE}}
{%- else -%}
{%- for snippet in doc.content -%}
{{snippet}}{{NEWLINE}}
{%- endfor -%}
{%- endif -%}
{{"---"}}
{%- endfor -%}
{%- endif -%}
⌘I