Reference
- Sessions
- Apps
- Agents
- Tasks
- Tools
- Models
- Datasources
- All Objects
Apps
Get App
Retrieve a JSON object of the retrieved app. Will also return a list of all tasks, tools, agents, models and datasources as a front end helper
GET
/
{resourceSlug}
/
app
/
{appId}
.json
curl --request GET \
--url https://app.agentcloud.dev/{resourceSlug}/app/{appId}.json
{
"csrf": "<string>",
"app": {
"_id": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"name": "<string>",
"role": "<string>",
"goal": "<string>",
"backstory": "<string>",
"modelId": "<string>",
"functionModelId": "<string>",
"verbose": true,
"allowDelegation": true,
"toolIds": [
"<string>"
],
"icon": {}
},
"tasks": [
{
"_id": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"agentId": "<string>",
"expectedOutput": "<string>",
"toolIds": [
"<string>"
],
"asyncExecution": true,
"context": [
"<string>"
],
"outputJson": {},
"outputPydantic": {},
"outputFile": "<string>",
"icon": {
"id": {},
"filename": "<string>"
},
"requiresHumanInput": true,
"displayOnlyFinalOutput": true,
"hidden": true,
"formFields": [
{
"position": "<string>",
"type": "string",
"name": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"options": [
"<string>"
],
"tooltip": "<string>"
}
],
"isStructuredOutput": true
}
],
"tools": [
{
"_id": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"type": "function",
"asdf": "<string>",
"retriever_type": "raw",
"retriever_config": {
"k": 123,
"metadata_field_info": [
{
"name": "<string>",
"description": "<string>",
"type": "string"
}
]
},
"datasourceId": "<string>",
"state": "pending",
"data": {
"runtime": "<string>",
"builtin": true,
"name": "<string>",
"description": "<string>",
"apiKey": "<string>",
"environmentVariables": {},
"parameters": {
"properties": {},
"required": [
"<string>"
]
},
"code": "<string>",
"requirements": "<string>",
"openAPIMatchKey": "<string>"
},
"icon": {
"id": {},
"filename": "<string>"
},
"hidden": true,
"functionId": "<string>",
"revisionId": "<string>",
"functionLogs": "<string>"
}
],
"agents": [
{
"_id": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"name": "<string>",
"role": "<string>",
"goal": "<string>",
"backstory": "<string>",
"modelId": "<string>",
"functionModelId": "<string>",
"verbose": true,
"allowDelegation": true,
"toolIds": [
"<string>"
],
"icon": {}
}
],
"models": [
{
"_id": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"name": "<string>",
"model": "<string>",
"embeddingLength": 123,
"modelType": "<string>",
"type": "<string>",
"config": {
"model": "<string>",
"api_key": "<string>",
"base_url": "<string>",
"cohere_api_key": "<string>",
"groq_api_key": "<string>"
}
}
],
"datasources": [
{
"_id": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"originalName": "<string>",
"filename": "<string>",
"sourceType": "<string>",
"sourceId": "<string>",
"destinationId": "<string>",
"workspaceId": "<string>",
"connectionId": "<string>",
"recordCount": {
"total": 123,
"success": 123,
"failure": 123
},
"connectionSettings": {
"prefix": "<string>",
"name": "<string>",
"sourceId": "<string>",
"destinationId": "<string>",
"status": "<string>",
"configurations": {},
"schedule": {
"scheduleType": "cron",
"cronExpression": "<string>"
},
"dataResidency": "<string>",
"namespaceDefinition": "<string>",
"namespaceFormat": "<string>",
"nonBreakingSchemaUpdatesBehavior": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"lastSyncedDate": "2023-11-07T05:31:56Z",
"status": "draft",
"discoveredSchema": {},
"chunkingConfig": {
"partitioning": "auto",
"strategy": "basic",
"max_characters": 123,
"new_after_n_chars": 123,
"overlap": 123,
"similarity_threshold": 0.5,
"overlap_all": true
},
"embeddingField": "<string>",
"timeWeightField": "<string>",
"modelId": "<string>",
"hidden": true,
"streamConfig": {},
"timeUnit": "<string>"
}
]
}
Path Parameters
The resourceSlug is a url parameter of the teamId associated with the user. Anywhere the resourceSlug is used can be interpreted as a teamId
The appId of the app to be retrieved
Response
200
app.json
JSON object containing the app with that teamId, will return an empty array if the request is successful but there are no associated agents.
The response is of type object
.
curl --request GET \
--url https://app.agentcloud.dev/{resourceSlug}/app/{appId}.json
{
"csrf": "<string>",
"app": {
"_id": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"name": "<string>",
"role": "<string>",
"goal": "<string>",
"backstory": "<string>",
"modelId": "<string>",
"functionModelId": "<string>",
"verbose": true,
"allowDelegation": true,
"toolIds": [
"<string>"
],
"icon": {}
},
"tasks": [
{
"_id": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"agentId": "<string>",
"expectedOutput": "<string>",
"toolIds": [
"<string>"
],
"asyncExecution": true,
"context": [
"<string>"
],
"outputJson": {},
"outputPydantic": {},
"outputFile": "<string>",
"icon": {
"id": {},
"filename": "<string>"
},
"requiresHumanInput": true,
"displayOnlyFinalOutput": true,
"hidden": true,
"formFields": [
{
"position": "<string>",
"type": "string",
"name": "<string>",
"label": "<string>",
"description": "<string>",
"required": true,
"options": [
"<string>"
],
"tooltip": "<string>"
}
],
"isStructuredOutput": true
}
],
"tools": [
{
"_id": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"type": "function",
"asdf": "<string>",
"retriever_type": "raw",
"retriever_config": {
"k": 123,
"metadata_field_info": [
{
"name": "<string>",
"description": "<string>",
"type": "string"
}
]
},
"datasourceId": "<string>",
"state": "pending",
"data": {
"runtime": "<string>",
"builtin": true,
"name": "<string>",
"description": "<string>",
"apiKey": "<string>",
"environmentVariables": {},
"parameters": {
"properties": {},
"required": [
"<string>"
]
},
"code": "<string>",
"requirements": "<string>",
"openAPIMatchKey": "<string>"
},
"icon": {
"id": {},
"filename": "<string>"
},
"hidden": true,
"functionId": "<string>",
"revisionId": "<string>",
"functionLogs": "<string>"
}
],
"agents": [
{
"_id": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"name": "<string>",
"role": "<string>",
"goal": "<string>",
"backstory": "<string>",
"modelId": "<string>",
"functionModelId": "<string>",
"verbose": true,
"allowDelegation": true,
"toolIds": [
"<string>"
],
"icon": {}
}
],
"models": [
{
"_id": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"name": "<string>",
"model": "<string>",
"embeddingLength": 123,
"modelType": "<string>",
"type": "<string>",
"config": {
"model": "<string>",
"api_key": "<string>",
"base_url": "<string>",
"cohere_api_key": "<string>",
"groq_api_key": "<string>"
}
}
],
"datasources": [
{
"_id": "<string>",
"orgId": "<string>",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"originalName": "<string>",
"filename": "<string>",
"sourceType": "<string>",
"sourceId": "<string>",
"destinationId": "<string>",
"workspaceId": "<string>",
"connectionId": "<string>",
"recordCount": {
"total": 123,
"success": 123,
"failure": 123
},
"connectionSettings": {
"prefix": "<string>",
"name": "<string>",
"sourceId": "<string>",
"destinationId": "<string>",
"status": "<string>",
"configurations": {},
"schedule": {
"scheduleType": "cron",
"cronExpression": "<string>"
},
"dataResidency": "<string>",
"namespaceDefinition": "<string>",
"namespaceFormat": "<string>",
"nonBreakingSchemaUpdatesBehavior": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"lastSyncedDate": "2023-11-07T05:31:56Z",
"status": "draft",
"discoveredSchema": {},
"chunkingConfig": {
"partitioning": "auto",
"strategy": "basic",
"max_characters": 123,
"new_after_n_chars": 123,
"overlap": 123,
"similarity_threshold": 0.5,
"overlap_all": true
},
"embeddingField": "<string>",
"timeWeightField": "<string>",
"modelId": "<string>",
"hidden": true,
"streamConfig": {},
"timeUnit": "<string>"
}
]
}