Create or update an agent.

POST

https://api.scoutos.com/agents

POST

/agents

1 from scoutos import Scout
2 
3 client = Scout(
4     api_key="YOUR_API_KEY",
5 )
6 client.agents.upsert(
7     agent="agent",
8     revision="revision",
9 )

1 {
2   "agent": {
3     "created_by": {
4       "type": "organization",
5       "id": "org-67890"
6     },
7     "updated_by": {
8       "type": "organization",
9       "id": "org-67890"
10     },
11     "name": "SupportBot",
12     "parent": "root-agent",
13     "visibility": {
14       "type": "organization",
15       "id": "org-67890"
16     },
17     "id": "agent-12345",
18     "doc_type": "agent",
19     "created_at": "2024-01-15T09:30:00Z",
20     "updated_at": "2024-01-15T09:30:00Z",
21     "is_seed": true,
22     "description": "Customer support assistant",
23     "profile_icon_fill": "#4A90E2",
24     "profile_asset_url": "https://cdn.example.com/assets/supportbot_avatar.png",
25     "active_revision": "rev-20240601",
26     "from_persona": "customer_service"
27   },
28   "revision": {
29     "created_by": {
30       "type": "organization",
31       "id": "org-67890"
32     },
33     "updated_by": {
34       "type": "organization",
35       "id": "org-67890"
36     },
37     "parent": "agent-12345",
38     "organization_id": "org-67890",
39     "model": "gpt-4",
40     "system": "You are a helpful customer support assistant.",
41     "id": "rev-20240601",
42     "doc_type": "agent_revision",
43     "created_at": "2024-01-15T09:30:00Z",
44     "updated_at": "2024-01-15T09:30:00Z",
45     "is_seed": true,
46     "model_provider": "open_ai",
47     "temperature": 0.7,
48     "response_style": "precise",
49     "max_tokens": 150,
50     "max_turns": 10,
51     "tool_config": {},
52     "conversation_starters": [
53       "Hello! How can I assist you today?"
54     ],
55     "dynamic_fallbacks": [
56       {
57         "model": "gpt-3.5-turbo",
58         "model_provider": "open_ai"
59       }
60     ]
61   }
62 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects a multipart form containing an optional file.

agentstringRequired

agent_idstring or nullOptional

activateboolean or nullOptionalDefaults to true

revisionstringRequired

agent_imagefileOptional

Response

Successful Response

agentobject

revisionobject or null

Authentication

Request

Response

Errors