Reference
- Sessions
- Apps
- Agents
- Tasks
- Tools
- Models
- Datasources
- All Objects
- Account
- Agent
- Asset
- BaseOpenApiParameters
- ChatMessage
- Crew
- Datasource
- DatasourceConnectionSettings
- DatasourceRecordCount
- DatasourceStream
- DatasourceStatusColors
- DynamicResponse
- FieldDescription
- FieldDescriptionMap
- FormFieldConfig
- FunctionProperty
- IconAttachment
- InsertResult
- MetadataFieldInfo
- Model
- MultiQueryRetrieverConfig
- Notification
- NotificationDetails
- NotificationType
- ObjectId
- OAuthStrategy
- Oauth Provider
- Org
- ProcessingErrorDetails
- Retriever
- RetrieverConfig
- SelfQueryRetrieverConfig
- Session
- SharingConfig
- SharingMode
- ShareLink
- ShareLinkType
- ShareLinkTypes
- SimilaritySearchRetrieverConfig
- StreamConfig
- StreamConfigMap
- Stripe
- SyncModes
- SystemUpdateDetails
- Task
- Team
- TeamDescription
- TeamModelResponse
- TempRedirectResponse
- TestDatasourceJSONBody
- TimeWeightedRetrieverConfig
- Tool
- ToolRevision
- ToolState
- ToolType
- UnstructuredChunkingConfig
- UnstructuredChunkingStrategy
- UnstructuredChunkingStrategyValues
- UnstructuredPartitioningStrategy
- UnstructuredPartitioningStrategyValues
- UserActionDetails
- WebhookDetails
- WebhookType
All Objects
Tool
Represents a tool within the system, including its configuration, state, and associated retrievers.
{
"_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>"
}
Assistant
Responses are generated using AI and may contain mistakes.