Environment API
List all application environments
| Path | Method | Protected |
|---|---|---|
/v1/apps/{application_id}/envs | GET | Yes |
Example Response JSON
{
"values": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
"name": "string",
"compatibilityCheck": true,
"versionCheck": true,
"securityOverrides": true,
"ownerAccountId": "2936251c-eefb-44ec-9d94-a810fc3cf72b",
"rolesFromActiveShares": [
"admin"
],
"currentDeployment": {
"revision": 0,
"deploymentRevision": 0,
"deploymentVersion": "string",
"deploymentHash": "string"
}
}
]
}Create an application environment
| Path | Method | Protected |
|---|---|---|
/v1/apps/{application_id}/envs | POST | Yes |
Example Request JSON
{
"name": "string",
"compatibilityCheck": true,
"versionCheck": true,
"securityOverrides": true
}Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
"name": "string",
"compatibilityCheck": true,
"versionCheck": true,
"securityOverrides": true,
"ownerAccountId": "2936251c-eefb-44ec-9d94-a810fc3cf72b",
"rolesFromActiveShares": [
"admin"
],
"currentDeployment": {
"revision": 0,
"deploymentRevision": 0,
"deploymentVersion": "string",
"deploymentHash": "string"
}
}Get application environment by name
| Path | Method | Protected |
|---|---|---|
/v1/apps/{application_id}/envs/{environment_name} | GET | Yes |
Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
"name": "string",
"compatibilityCheck": true,
"versionCheck": true,
"securityOverrides": true,
"ownerAccountId": "2936251c-eefb-44ec-9d94-a810fc3cf72b",
"rolesFromActiveShares": [
"admin"
],
"currentDeployment": {
"revision": 0,
"deploymentRevision": 0,
"deploymentVersion": "string",
"deploymentHash": "string"
}
}Get environment by id.
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id} | GET | Yes |
Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
"name": "string",
"compatibilityCheck": true,
"versionCheck": true,
"securityOverrides": true,
"ownerAccountId": "2936251c-eefb-44ec-9d94-a810fc3cf72b",
"rolesFromActiveShares": [
"admin"
],
"currentDeployment": {
"revision": 0,
"deploymentRevision": 0,
"deploymentVersion": "string",
"deploymentHash": "string"
}
}Delete environment by id.
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id} | DELETE | Yes |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| current_revision | integer | Yes | - |
Update environment by id.
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id} | PATCH | Yes |
Example Request JSON
{
"currentRevision": 0,
"name": "string",
"compatibilityCheck": true,
"versionCheck": true,
"securityOverrides": true
}Example Response JSON
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
"name": "string",
"compatibilityCheck": true,
"versionCheck": true,
"securityOverrides": true,
"ownerAccountId": "2936251c-eefb-44ec-9d94-a810fc3cf72b",
"rolesFromActiveShares": [
"admin"
],
"currentDeployment": {
"revision": 0,
"deploymentRevision": 0,
"deploymentVersion": "string",
"deploymentHash": "string"
}
}Get the current deployment plan
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/plan | GET | Yes |
Example Response JSON
{
"currentRevision": 0,
"deploymentHash": "string",
"components": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"name": "string",
"hash": "string"
}
],
"httpApiDeployments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"domain": "string",
"hash": "string"
}
],
"mcpDeployments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"domain": "string",
"hash": "string"
}
]
}Rollback an environment to a previous deployment
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/current-deployment | PUT | Yes |
Example Request JSON
{
"currentRevision": 0,
"deploymentRevision": 0
}Example Response JSON
{
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"revision": 0,
"version": "string",
"deploymentHash": "string",
"currentRevision": 0
}List all deployments in this environment
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/deployments | GET | Yes |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| version | string | No | - |
Example Response JSON
{
"values": [
{
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"revision": 0,
"version": "string",
"deploymentHash": "string"
}
]
}Deploy the current staging area of this environment
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/deployments | POST | Yes |
Example Request JSON
{
"currentRevision": 0,
"expectedDeploymentHash": "string",
"version": "string",
"agentSecretDefaults": [
{
"path": [
"string"
],
"secretValue": null
}
],
"quotaResourceDefaults": [
{
"name": "string",
"limit": {
"type": "Rate",
"value": 0,
"period": "second",
"max": 0
},
"enforcementAction": "reject",
"unit": "string",
"units": "string"
}
],
"retryPolicyDefaults": [
{
"name": "string",
"priority": 0,
"predicate": {
"type": "PropLte",
"property": "string",
"value": {
"type": "Text",
"value": "string"
}
},
"policy": {
"type": "Periodic",
"delayMs": 0
}
}
]
}Example Response JSON
{
"environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
"revision": 0,
"version": "string",
"deploymentHash": "string",
"currentRevision": 0
}Get the deployment summary of a deployed deployment
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/deployments/{deployment_id}/summary | GET | Yes |
Example Response JSON
{
"deploymentRevision": 0,
"deploymentHash": "string",
"components": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"name": "string",
"hash": "string"
}
],
"httpApiDeployments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"domain": "string",
"hash": "string"
}
],
"mcpDeployments": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"revision": 0,
"domain": "string",
"hash": "string"
}
]
}List all registered agent types in a deployment
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/deployments/{deployment_id}/agent-types | GET | Yes |
Example Response JSON
{
"values": [
{
"agentType": {
"typeName": "string",
"description": "string",
"sourceLanguage": "string",
"constructor": {
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
}
},
"methods": [
{
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
},
"outputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
},
"httpEndpoint": [
{
"httpMethod": {
"type": "Patch"
},
"pathSuffix": [
{
"type": "Literal",
"value": "string"
}
],
"headerVars": [
{
"headerName": "string",
"variableName": "string"
}
],
"queryVars": [
{
"queryParamName": "string",
"variableName": "string"
}
],
"authDetails": {
"required": true
},
"corsOptions": {
"allowedPatterns": [
"string"
]
}
}
]
}
],
"dependencies": [
{
"typeName": "string",
"description": "string",
"constructor": {
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
}
},
"methods": [
{
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{}
]
}
}
}
]
},
"outputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{}
]
}
}
}
]
},
"httpEndpoint": [
{
"httpMethod": {
"type": "Patch"
},
"pathSuffix": [
{
"type": "Literal",
"value": "string"
}
],
"headerVars": [
{
"headerName": "string",
"variableName": "string"
}
],
"queryVars": [
{
"queryParamName": "string",
"variableName": "string"
}
],
"authDetails": {
"required": true
},
"corsOptions": {
"allowedPatterns": [
"string"
]
}
}
]
}
]
}
],
"mode": "Durable",
"httpMount": {
"pathPrefix": [
{
"type": "Literal",
"value": "string"
}
],
"authDetails": {
"required": true
},
"phantomAgent": true,
"corsOptions": {
"allowedPatterns": [
"string"
]
},
"webhookSuffix": [
{
"type": "Literal",
"value": "string"
}
]
},
"snapshotting": {
"type": "Disabled"
},
"config": [
{
"source": "Local",
"path": [
"string"
],
"valueType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
]
},
"implementedBy": {
"componentId": "616ccd92-d666-4180-8349-8d125b269fac",
"componentRevision": 0
},
"webhookPrefixAuthorityAndPath": "string"
}
]
}Get a registered agent type in a deployment
| Path | Method | Protected |
|---|---|---|
/v1/envs/{environment_id}/deployments/{deployment_id}/agent-types/{agent_type_name} | GET | Yes |
Example Response JSON
{
"agentType": {
"typeName": "string",
"description": "string",
"sourceLanguage": "string",
"constructor": {
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
}
},
"methods": [
{
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
},
"outputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
},
"httpEndpoint": [
{
"httpMethod": {
"type": "Patch"
},
"pathSuffix": [
{
"type": "Literal",
"value": "string"
}
],
"headerVars": [
{
"headerName": "string",
"variableName": "string"
}
],
"queryVars": [
{
"queryParamName": "string",
"variableName": "string"
}
],
"authDetails": {
"required": true
},
"corsOptions": {
"allowedPatterns": [
"string"
]
}
}
]
}
],
"dependencies": [
{
"typeName": "string",
"description": "string",
"constructor": {
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
}
},
"methods": [
{
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
},
"outputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
},
"httpEndpoint": [
{
"httpMethod": {
"type": "Patch"
},
"pathSuffix": [
{
"type": "Literal",
"value": "string"
}
],
"headerVars": [
{
"headerName": "string",
"variableName": "string"
}
],
"queryVars": [
{
"queryParamName": "string",
"variableName": "string"
}
],
"authDetails": {
"required": true
},
"corsOptions": {
"allowedPatterns": [
"string"
]
}
}
]
}
]
}
],
"mode": "Durable",
"httpMount": {
"pathPrefix": [
{
"type": "Literal",
"value": "string"
}
],
"authDetails": {
"required": true
},
"phantomAgent": true,
"corsOptions": {
"allowedPatterns": [
"string"
]
},
"webhookSuffix": [
{
"type": "Literal",
"value": "string"
}
]
},
"snapshotting": {
"type": "Disabled"
},
"config": [
{
"source": "Local",
"path": [
"string"
],
"valueType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
]
},
"implementedBy": {
"componentId": "616ccd92-d666-4180-8349-8d125b269fac",
"componentRevision": 0
},
"webhookPrefixAuthorityAndPath": "string"
}Environment API Errors
| Status Code | Description | Body |
|---|---|---|
| 400 | Invalid request, returning with a list of issues detected in the request | {"code":"string","errors":["string"]} |
| 401 | Unauthorized request | {"code":"string","error":"string"} |
| 403 | Forbidden Request | {"code":"string","error":"string"} |
| 404 | Entity not found | {"code":"string","error":"string"} |
| 409 | {"code":"string","error":"string"} | |
| 422 | Limits of the plan exceeded | {"code":"string","error":"string"} |
| 500 | Internal server error | {"code":"string","error":"string"} |
Last updated on