API Reference
Projects
Copy page
Operations for managing projects
Create Full Project
Authorization
bearerAuth cookieAuth AuthorizationBearer <token>
Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
better-auth.session_token<token>
Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.
In: cookie
Path Parameters
tenantId*string
Tenant identifier
Request Body
application/json
description?string
id*string
Length
length <= 256models*
name*string
Length
length <= 256stopWhen?
agents*
artifactComponents?
createdAt?string
credentialReferences?
dataComponents?
externalAgents?
functionTools?
functions?
statusUpdates?
tools*
updatedAt?string
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/json
application/problem+json
application/problem+json
curl -X POST "https://api.pilot.inkeep.com/manage/tenants/tenant_123/project-full" \ -H "Content-Type: application/json" \ -d '{ "id": "string", "models": { "base": {} }, "name": "string", "agents": { "property1": { "id": "resource_789", "name": "string", "subAgents": { "property1": { "id": "resource_789", "name": "string", "canUse": [ { "toolId": "string" } ], "type": "internal" }, "property2": { "id": "resource_789", "name": "string", "canUse": [ { "toolId": "string" } ], "type": "internal" } } }, "property2": { "id": "resource_789", "name": "string", "subAgents": { "property1": { "id": "resource_789", "name": "string", "canUse": [ { "toolId": "string" } ], "type": "internal" }, "property2": { "id": "resource_789", "name": "string", "canUse": [ { "toolId": "string" } ], "type": "internal" } } } }, "tools": { "property1": { "config": { "mcp": { "server": { "url": "http://example.com" } }, "type": "mcp" }, "id": "resource_789", "name": "string" }, "property2": { "config": { "mcp": { "server": { "url": "http://example.com" } }, "type": "mcp" }, "id": "resource_789", "name": "string" } } }'{
"data": {
"createdAt": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"stopWhen": {
"stepCountIs": 1,
"transferCountIs": 1
},
"updatedAt": "string",
"agents": {
"property1": {
"contextConfigId": "string",
"createdAt": "string",
"defaultSubAgentId": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"prompt": "string",
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"stopWhen": {
"transferCountIs": 1
},
"updatedAt": "string",
"contextConfig": {
"contextVariables": "string",
"createdAt": "string",
"headersSchema": {},
"id": "string",
"updatedAt": "string"
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"subAgents": {
"property1": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
},
"property2": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
}
},
"teamAgents": {
"property1": {
"description": "string",
"id": "string",
"name": "string"
},
"property2": {
"description": "string",
"id": "string",
"name": "string"
}
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
},
"property2": {
"contextConfigId": "string",
"createdAt": "string",
"defaultSubAgentId": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"prompt": "string",
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"stopWhen": {
"transferCountIs": 1
},
"updatedAt": "string",
"contextConfig": {
"contextVariables": "string",
"createdAt": "string",
"headersSchema": {},
"id": "string",
"updatedAt": "string"
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"subAgents": {
"property1": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
},
"property2": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
}
},
"teamAgents": {
"property1": {
"description": "string",
"id": "string",
"name": "string"
},
"property2": {
"description": "string",
"id": "string",
"name": "string"
}
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
}
},
"artifactComponents": {
"property1": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
}
},
"credentialReferences": {
"property1": {
"createdAt": "string",
"createdBy": "string",
"credentialStoreId": "string",
"externalAgents": [
{
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"id": "string",
"name": "string",
"retrievalParams": "string",
"toolId": "string",
"tools": [
{
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"type": "memory",
"updatedAt": "string",
"userId": "string"
},
"property2": {
"createdAt": "string",
"createdBy": "string",
"credentialStoreId": "string",
"externalAgents": [
{
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"id": "string",
"name": "string",
"retrievalParams": "string",
"toolId": "string",
"tools": [
{
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"type": "memory",
"updatedAt": "string",
"userId": "string"
}
},
"dataComponents": {
"property1": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
}
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"details": null,
"error": "string",
"message": "string"
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Get Full Project
Authorization
bearerAuth cookieAuth AuthorizationBearer <token>
Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
better-auth.session_token<token>
Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.
In: cookie
Path Parameters
tenantId*string
Tenant identifier
projectId*string
Project identifier
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://api.pilot.inkeep.com/manage/tenants/tenant_123/project-full/project_456"{
"data": {
"createdAt": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"stopWhen": {
"stepCountIs": 1,
"transferCountIs": 1
},
"updatedAt": "string",
"agents": {
"property1": {
"contextConfigId": "string",
"createdAt": "string",
"defaultSubAgentId": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"prompt": "string",
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"stopWhen": {
"transferCountIs": 1
},
"updatedAt": "string",
"contextConfig": {
"contextVariables": "string",
"createdAt": "string",
"headersSchema": {},
"id": "string",
"updatedAt": "string"
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"subAgents": {
"property1": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
},
"property2": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
}
},
"teamAgents": {
"property1": {
"description": "string",
"id": "string",
"name": "string"
},
"property2": {
"description": "string",
"id": "string",
"name": "string"
}
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
},
"property2": {
"contextConfigId": "string",
"createdAt": "string",
"defaultSubAgentId": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"prompt": "string",
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"stopWhen": {
"transferCountIs": 1
},
"updatedAt": "string",
"contextConfig": {
"contextVariables": "string",
"createdAt": "string",
"headersSchema": {},
"id": "string",
"updatedAt": "string"
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"subAgents": {
"property1": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
},
"property2": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
}
},
"teamAgents": {
"property1": {
"description": "string",
"id": "string",
"name": "string"
},
"property2": {
"description": "string",
"id": "string",
"name": "string"
}
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
}
},
"artifactComponents": {
"property1": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
}
},
"credentialReferences": {
"property1": {
"createdAt": "string",
"createdBy": "string",
"credentialStoreId": "string",
"externalAgents": [
{
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"id": "string",
"name": "string",
"retrievalParams": "string",
"toolId": "string",
"tools": [
{
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"type": "memory",
"updatedAt": "string",
"userId": "string"
},
"property2": {
"createdAt": "string",
"createdBy": "string",
"credentialStoreId": "string",
"externalAgents": [
{
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"id": "string",
"name": "string",
"retrievalParams": "string",
"toolId": "string",
"tools": [
{
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"type": "memory",
"updatedAt": "string",
"userId": "string"
}
},
"dataComponents": {
"property1": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
}
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Delete Full Project
Authorization
bearerAuth cookieAuth AuthorizationBearer <token>
Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
better-auth.session_token<token>
Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.
In: cookie
Path Parameters
tenantId*string
Tenant identifier
projectId*string
Project identifier
Response Body
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X DELETE "https://api.pilot.inkeep.com/manage/tenants/tenant_123/project-full/project_456"Empty
{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Update Full Project
Authorization
bearerAuth cookieAuth AuthorizationBearer <token>
Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
better-auth.session_token<token>
Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.
In: cookie
Path Parameters
tenantId*string
Tenant identifier
projectId*string
Project identifier
Request Body
application/json
description?string
id*string
Length
length <= 256models*
name*string
Length
length <= 256stopWhen?
agents*
artifactComponents?
createdAt?string
credentialReferences?
dataComponents?
externalAgents?
functionTools?
functions?
statusUpdates?
tools*
updatedAt?string
Response Body
application/json
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X PUT "https://api.pilot.inkeep.com/manage/tenants/tenant_123/project-full/project_456" \ -H "Content-Type: application/json" \ -d '{ "id": "string", "models": { "base": {} }, "name": "string", "agents": { "property1": { "id": "resource_789", "name": "string", "subAgents": { "property1": { "id": "resource_789", "name": "string", "canUse": [ { "toolId": "string" } ], "type": "internal" }, "property2": { "id": "resource_789", "name": "string", "canUse": [ { "toolId": "string" } ], "type": "internal" } } }, "property2": { "id": "resource_789", "name": "string", "subAgents": { "property1": { "id": "resource_789", "name": "string", "canUse": [ { "toolId": "string" } ], "type": "internal" }, "property2": { "id": "resource_789", "name": "string", "canUse": [ { "toolId": "string" } ], "type": "internal" } } } }, "tools": { "property1": { "config": { "mcp": { "server": { "url": "http://example.com" } }, "type": "mcp" }, "id": "resource_789", "name": "string" }, "property2": { "config": { "mcp": { "server": { "url": "http://example.com" } }, "type": "mcp" }, "id": "resource_789", "name": "string" } } }'{
"data": {
"createdAt": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"stopWhen": {
"stepCountIs": 1,
"transferCountIs": 1
},
"updatedAt": "string",
"agents": {
"property1": {
"contextConfigId": "string",
"createdAt": "string",
"defaultSubAgentId": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"prompt": "string",
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"stopWhen": {
"transferCountIs": 1
},
"updatedAt": "string",
"contextConfig": {
"contextVariables": "string",
"createdAt": "string",
"headersSchema": {},
"id": "string",
"updatedAt": "string"
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"subAgents": {
"property1": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
},
"property2": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
}
},
"teamAgents": {
"property1": {
"description": "string",
"id": "string",
"name": "string"
},
"property2": {
"description": "string",
"id": "string",
"name": "string"
}
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
},
"property2": {
"contextConfigId": "string",
"createdAt": "string",
"defaultSubAgentId": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"prompt": "string",
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"stopWhen": {
"transferCountIs": 1
},
"updatedAt": "string",
"contextConfig": {
"contextVariables": "string",
"createdAt": "string",
"headersSchema": {},
"id": "string",
"updatedAt": "string"
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"subAgents": {
"property1": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
},
"property2": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
}
},
"teamAgents": {
"property1": {
"description": "string",
"id": "string",
"name": "string"
},
"property2": {
"description": "string",
"id": "string",
"name": "string"
}
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
}
},
"artifactComponents": {
"property1": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
}
},
"credentialReferences": {
"property1": {
"createdAt": "string",
"createdBy": "string",
"credentialStoreId": "string",
"externalAgents": [
{
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"id": "string",
"name": "string",
"retrievalParams": "string",
"toolId": "string",
"tools": [
{
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"type": "memory",
"updatedAt": "string",
"userId": "string"
},
"property2": {
"createdAt": "string",
"createdBy": "string",
"credentialStoreId": "string",
"externalAgents": [
{
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"id": "string",
"name": "string",
"retrievalParams": "string",
"toolId": "string",
"tools": [
{
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"type": "memory",
"updatedAt": "string",
"userId": "string"
}
},
"dataComponents": {
"property1": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
}
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
}
}{
"data": {
"createdAt": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"stopWhen": {
"stepCountIs": 1,
"transferCountIs": 1
},
"updatedAt": "string",
"agents": {
"property1": {
"contextConfigId": "string",
"createdAt": "string",
"defaultSubAgentId": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"prompt": "string",
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"stopWhen": {
"transferCountIs": 1
},
"updatedAt": "string",
"contextConfig": {
"contextVariables": "string",
"createdAt": "string",
"headersSchema": {},
"id": "string",
"updatedAt": "string"
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"subAgents": {
"property1": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
},
"property2": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
}
},
"teamAgents": {
"property1": {
"description": "string",
"id": "string",
"name": "string"
},
"property2": {
"description": "string",
"id": "string",
"name": "string"
}
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
},
"property2": {
"contextConfigId": "string",
"createdAt": "string",
"defaultSubAgentId": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"prompt": "string",
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"stopWhen": {
"transferCountIs": 1
},
"updatedAt": "string",
"contextConfig": {
"contextVariables": "string",
"createdAt": "string",
"headersSchema": {},
"id": "string",
"updatedAt": "string"
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"subAgents": {
"property1": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
},
"property2": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
"string"
],
"canTransferTo": [
"string"
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
}
},
"teamAgents": {
"property1": {
"description": "string",
"id": "string",
"name": "string"
},
"property2": {
"description": "string",
"id": "string",
"name": "string"
}
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
}
},
"artifactComponents": {
"property1": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
}
},
"credentialReferences": {
"property1": {
"createdAt": "string",
"createdBy": "string",
"credentialStoreId": "string",
"externalAgents": [
{
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"id": "string",
"name": "string",
"retrievalParams": "string",
"toolId": "string",
"tools": [
{
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"type": "memory",
"updatedAt": "string",
"userId": "string"
},
"property2": {
"createdAt": "string",
"createdBy": "string",
"credentialStoreId": "string",
"externalAgents": [
{
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"id": "string",
"name": "string",
"retrievalParams": "string",
"toolId": "string",
"tools": [
{
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"type": "memory",
"updatedAt": "string",
"userId": "string"
}
},
"dataComponents": {
"property1": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
}
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Get Full Project with Relation IDs
Authorization
bearerAuth cookieAuth AuthorizationBearer <token>
Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
better-auth.session_token<token>
Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.
In: cookie
Path Parameters
tenantId*string
Tenant identifier
projectId*string
Project identifier
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://api.pilot.inkeep.com/manage/tenants/tenant_123/project-full/project_456/with-relation-ids"{
"data": {
"createdAt": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"stopWhen": {
"stepCountIs": 1,
"transferCountIs": 1
},
"updatedAt": "string",
"agents": {
"property1": {
"contextConfigId": "string",
"createdAt": "string",
"defaultSubAgentId": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"prompt": "string",
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"stopWhen": {
"transferCountIs": 1
},
"updatedAt": "string",
"contextConfig": {
"contextVariables": "string",
"createdAt": "string",
"headersSchema": {},
"id": "string",
"updatedAt": "string"
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"subAgents": {
"property1": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
{
"subAgentId": "string",
"subAgentSubAgentRelationId": "string"
}
],
"canTransferTo": [
{
"subAgentId": "string",
"subAgentSubAgentRelationId": "string"
}
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
},
"property2": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
{
"subAgentId": "string",
"subAgentSubAgentRelationId": "string"
}
],
"canTransferTo": [
{
"subAgentId": "string",
"subAgentSubAgentRelationId": "string"
}
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
}
},
"teamAgents": {
"property1": {
"description": "string",
"id": "string",
"name": "string"
},
"property2": {
"description": "string",
"id": "string",
"name": "string"
}
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
},
"property2": {
"contextConfigId": "string",
"createdAt": "string",
"defaultSubAgentId": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"prompt": "string",
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"stopWhen": {
"transferCountIs": 1
},
"updatedAt": "string",
"contextConfig": {
"contextVariables": "string",
"createdAt": "string",
"headersSchema": {},
"id": "string",
"updatedAt": "string"
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"subAgents": {
"property1": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
{
"subAgentId": "string",
"subAgentSubAgentRelationId": "string"
}
],
"canTransferTo": [
{
"subAgentId": "string",
"subAgentSubAgentRelationId": "string"
}
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
},
"property2": {
"conversationHistoryConfig": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"models": "string",
"name": "string",
"prompt": "string",
"stopWhen": "string",
"updatedAt": "string",
"artifactComponents": [
"string"
],
"canDelegateTo": [
{
"subAgentId": "string",
"subAgentSubAgentRelationId": "string"
}
],
"canTransferTo": [
{
"subAgentId": "string",
"subAgentSubAgentRelationId": "string"
}
],
"canUse": [
{
"agentToolRelationId": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"toolId": "string",
"toolPolicies": {
"property1": {
"needsApproval": true
},
"property2": {
"needsApproval": true
}
},
"toolSelection": [
"string"
]
}
],
"dataComponents": [
"string"
],
"type": "internal"
}
},
"teamAgents": {
"property1": {
"description": "string",
"id": "string",
"name": "string"
},
"property2": {
"description": "string",
"id": "string",
"name": "string"
}
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
}
},
"artifactComponents": {
"property1": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
}
},
"credentialReferences": {
"property1": {
"createdAt": "string",
"createdBy": "string",
"credentialStoreId": "string",
"externalAgents": [
{
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"id": "string",
"name": "string",
"retrievalParams": "string",
"toolId": "string",
"tools": [
{
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"type": "memory",
"updatedAt": "string",
"userId": "string"
},
"property2": {
"createdAt": "string",
"createdBy": "string",
"credentialStoreId": "string",
"externalAgents": [
{
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"id": "string",
"name": "string",
"retrievalParams": "string",
"toolId": "string",
"tools": [
{
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"projectId": "string",
"tenantId": "string",
"updatedAt": "string"
}
],
"type": "memory",
"updatedAt": "string",
"userId": "string"
}
},
"dataComponents": {
"property1": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"props": "string",
"render": "string",
"updatedAt": "string"
}
},
"externalAgents": {
"property1": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"baseUrl": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string"
}
},
"functionTools": {
"property1": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
},
"property2": {
"agentId": "string",
"createdAt": "string",
"description": "string",
"functionId": "string",
"id": "string",
"name": "string",
"relationshipId": "string",
"updatedAt": "string"
}
},
"functions": {
"property1": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
},
"property2": {
"createdAt": "string",
"dependencies": "string",
"executeCode": "string",
"id": "string",
"inputSchema": "string",
"updatedAt": "string"
}
},
"statusUpdates": {
"enabled": true,
"numEvents": 1,
"prompt": "string",
"statusComponents": [
{
"description": "string",
"detailsSchema": {
"properties": {
"property1": null,
"property2": null
},
"required": [
"string"
],
"type": "object"
},
"type": "string"
}
],
"timeInSeconds": 1
},
"tools": {
"property1": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
},
"property2": {
"capabilities": "string",
"config": "string",
"createdAt": "string",
"credentialReferenceId": "string",
"credentialScope": "string",
"description": "string",
"headers": "string",
"id": "string",
"imageUrl": "string",
"lastError": "string",
"name": "string",
"updatedAt": "string"
}
}
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}List Projects
Authorization
bearerAuth cookieAuth AuthorizationBearer <token>
Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
better-auth.session_token<token>
Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.
In: cookie
Path Parameters
tenantId*string
Tenant identifier
Query Parameters
page?number
Default
1Range
1 <= valuelimit?number
Default
10Range
1 <= value <= 100Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://api.pilot.inkeep.com/manage/tenants/tenant_123/projects"{
"data": [
{
"createdAt": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"stopWhen": {
"stepCountIs": 1,
"transferCountIs": 1
},
"updatedAt": "string"
}
],
"pagination": {
"limit": 10,
"page": 1,
"pages": 0,
"total": 0
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Create Project
Authorization
bearerAuth cookieAuth AuthorizationBearer <token>
Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
better-auth.session_token<token>
Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.
In: cookie
Path Parameters
tenantId*string
Tenant identifier
Request Body
application/json
description?string
id*string
Length
length <= 256models*
name*string
Length
length <= 256stopWhen?
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/json
application/problem+json
application/problem+json
curl -X POST "https://api.pilot.inkeep.com/manage/tenants/tenant_123/projects" \ -H "Content-Type: application/json" \ -d '{ "id": "string", "models": { "base": {} }, "name": "string" }'{
"data": {
"createdAt": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"stopWhen": {
"stepCountIs": 1,
"transferCountIs": 1
},
"updatedAt": "string"
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"details": null,
"error": "string",
"message": "string"
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Get Project
Authorization
bearerAuth cookieAuth AuthorizationBearer <token>
Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
better-auth.session_token<token>
Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.
In: cookie
Path Parameters
tenantId*string
Tenant identifier
id*string
Resource identifier
Match
^[a-zA-Z0-9\-_.]+$Length
1 <= length <= 255Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://api.pilot.inkeep.com/manage/tenants/tenant_123/projects/resource_789"{
"data": {
"createdAt": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"stopWhen": {
"stepCountIs": 1,
"transferCountIs": 1
},
"updatedAt": "string"
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Update Project
Authorization
bearerAuth cookieAuth AuthorizationBearer <token>
Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
better-auth.session_token<token>
Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.
In: cookie
Path Parameters
tenantId*string
Tenant identifier
id*string
Resource identifier
Match
^[a-zA-Z0-9\-_.]+$Length
1 <= length <= 255Request Body
application/json
description?string
models?
name?string
Length
length <= 256stopWhen?
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X PATCH "https://api.pilot.inkeep.com/manage/tenants/tenant_123/projects/resource_789" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"createdAt": "string",
"description": "string",
"id": "string",
"models": {
"base": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"structuredOutput": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
},
"summarizer": {
"model": "string",
"providerOptions": {
"property1": null,
"property2": null
}
}
},
"name": "string",
"stopWhen": {
"stepCountIs": 1,
"transferCountIs": 1
},
"updatedAt": "string"
}
}{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}Delete Project
Authorization
bearerAuth cookieAuth AuthorizationBearer <token>
Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".
In: header
better-auth.session_token<token>
Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.
In: cookie
Path Parameters
tenantId*string
Tenant identifier
id*string
Resource identifier
Match
^[a-zA-Z0-9\-_.]+$Length
1 <= length <= 255Response Body
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/json
application/problem+json
application/problem+json
curl -X DELETE "https://api.pilot.inkeep.com/manage/tenants/tenant_123/projects/resource_789"Empty
{
"code": "bad_request",
"detail": "Bad Request",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 400,
"title": "Bad Request",
"error": {
"code": "bad_request",
"message": "Bad Request"
}
}{
"code": "unauthorized",
"detail": "Unauthorized",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 401,
"title": "Unauthorized",
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"code": "forbidden",
"detail": "Forbidden",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 403,
"title": "Forbidden",
"error": {
"code": "forbidden",
"message": "Forbidden"
}
}{
"code": "not_found",
"detail": "Not Found",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 404,
"title": "Not Found",
"error": {
"code": "not_found",
"message": "Not Found"
}
}{
"details": null,
"error": "string",
"message": "string"
}{
"code": "unprocessable_entity",
"detail": "Unprocessable Entity",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 422,
"title": "Unprocessable Entity",
"error": {
"code": "unprocessable_entity",
"message": "Unprocessable Entity"
}
}{
"code": "internal_server_error",
"detail": "Internal Server Error",
"instance": "/conversations/123",
"requestId": "req_1234567890",
"status": 500,
"title": "Internal Server Error",
"error": {
"code": "internal_server_error",
"message": "Internal Server Error"
}
}