---
title: "Agent Deployments"
url: "https://nexora.apim.eu/apis/agent-deployments/versions/3a3ada6b-888e-498a-bfb3-a134ac91f753"
---

# Agent Deployments

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Agent Deployments","version":"1.0.0","description":"The system of record for every deployed AI agent - copilots, autonomous\nagents, workflow agents and RAG assistants. Agent deployments are the\nfoundation for catalog entries, access requests and cost estimation.\n\nThe inventory can be populated and exported via a standard agent-inventory\nfeed, so existing CMDB and MLOps tooling connects without an extra\nintegration step.\n","contact":{"name":"API Support - Nexora AI","email":"api-support@nexora.example"},"license":{"name":"For demonstration purposes only"}},"servers":[{"url":"https://api.nexora.example/v1","description":"Production"},{"url":"https://sandbox.api.nexora.example/v1","description":"Sandbox"}],"tags":[{"name":"Agents"},{"name":"Artifacts"},{"name":"Import"}],"security":[{"apiKey":[]}],"paths":{"/agents":{"get":{"tags":["Agents"],"summary":"List agent deployments","operationId":"listAgents","parameters":[{"name":"status","in":"query","schema":{"$ref":"#/components/schemas/AgentStatus"}},{"name":"category","in":"query","schema":{"$ref":"#/components/schemas/AgentCategory"}},{"name":"business_unit","in":"query","description":"Filter by owning business unit.","schema":{"type":"string","example":"Platform Engineering"}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"cursor","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Results list","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"page":{"$ref":"#/components/schemas/Page"}}}}}},"401":{"$ref":"#/components/responses/NotAuthenticated"},"429":{"$ref":"#/components/responses/TooManyRequests"}}},"post":{"tags":["Agents"],"summary":"Register an agent deployment","operationId":"registerAgent","security":[{"apiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentInput"},"example":{"category":"copilot","deployment_tier":"pilot","title":"Internal Support Triage Copilot","owning_team":{"owning_team":"Support Engineering","business_unit":"Customer Success","cost_center":"CC-4021"},"integration_count":6,"tool_count":4,"model_provider":"Anthropic Claude","model_release_date":"2026-02-01","cost_per_1k_tokens_usd":0.015,"chargeback":{"rate_percent":12,"note":"includes shared platform overhead"}}}}},"responses":{"201":{"description":"Registered","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/NotAuthenticated"}}}},"/agents/{agentId}":{"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string","example":"agt_8f2c1a"}}],"get":{"tags":["Agents"],"summary":"Retrieve an agent deployment","operationId":"getAgent","responses":{"200":{"description":"Agent deployment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"404":{"$ref":"#/components/responses/NotFound"}}},"patch":{"tags":["Agents"],"summary":"Update an agent deployment","description":"Updates individual fields. Catalog entries already generated remain unchanged.","operationId":"updateAgent","security":[{"apiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentInput"},"example":{"deployment_tier":"production"}}}},"responses":{"200":{"description":"Updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"404":{"$ref":"#/components/responses/NotFound"}}},"delete":{"tags":["Agents"],"summary":"Retire an agent deployment","description":"Takes the agent out of active service. The record remains readable.","operationId":"retireAgent","security":[{"apiKey":[]}],"responses":{"204":{"description":"Retired"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/agents/{agentId}/artifacts":{"parameters":[{"name":"agentId","in":"path","required":true,"schema":{"type":"string","example":"agt_8f2c1a"}}],"get":{"tags":["Artifacts"],"summary":"List an agent's artifacts","operationId":"listAgentArtifacts","responses":{"200":{"description":"Artifact list","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Artifact"}}}}}}}}},"post":{"tags":["Artifacts"],"summary":"Upload an artifact","description":"Model cards, architecture diagrams and evaluation reports are attached to the agent, not to a catalog entry.","operationId":"uploadAgentArtifact","security":[{"apiKey":[]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file","category"],"properties":{"file":{"type":"string","format":"binary"},"category":{"$ref":"#/components/schemas/ArtifactCategory"},"order":{"type":"integer","minimum":1,"example":1},"caption":{"type":"string","maxLength":160}}}}}},"responses":{"201":{"description":"Uploaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Artifact"}}}},"413":{"description":"File too large (limit 25 MB)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/import/feed":{"post":{"tags":["Import"],"summary":"Import an agent inventory feed","description":"Accepts a JSON or CSV agent-inventory feed and creates or updates the\nagent deployments it contains. The import runs asynchronously.\n","operationId":"importAgentInventoryFeed","security":[{"apiKey":[]}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary"},"mode":{"type":"string","enum":["merge","replace"],"default":"merge","description":"`replace` retires agents that aren't in the file."}}}}}},"responses":{"202":{"description":"Import accepted","content":{"application/json":{"schema":{"type":"object","properties":{"import_id":{"type":"string","example":"imp_2f71"},"status":{"type":"string","enum":["in_progress","done","failed"]},"agents_detected":{"type":"integer","example":47}}}}}}}}}},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"apikey","description":"Every call carries an API key in the `apikey` header. You generate the\nkey in the Nexora AI portal under \"My Apps\"; it's shown exactly once.\n\nEach key has the scopes it's allowed to use attached to it. If one is\nmissing, the API responds with `403` and `code: \"scope_missing\"`; the\nmissing scope is in `details[].field`.\n"}},"responses":{"NotAuthenticated":{"description":"Key is missing, revoked or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Record not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"ValidationError":{"description":"The request doesn't match the schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"TooManyRequests":{"description":"Rate limit reached","headers":{"Retry-After":{"schema":{"type":"integer","example":12}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Page":{"type":"object","description":"Cursor-based pagination.","properties":{"count":{"type":"integer","example":25},"total":{"type":"integer","example":138},"next_cursor":{"type":"string","nullable":true,"example":"eyJzIjoyNX0"}}},"ErrorDetail":{"type":"object","properties":{"field":{"type":"string","example":"compliance_certification.valid_until"},"reason":{"type":"string","example":"missing"}}},"Error":{"type":"object","description":"Uniform error format across all Nexora AI APIs.","required":["code","message"],"properties":{"code":{"type":"string","example":"validation_failed"},"message":{"type":"string","example":"Compliance disclosures from the certification are missing."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"}}}},"AgentStatus":{"type":"string","enum":["draft","active","paused","deprecated","retired","archived"],"example":"active"},"AgentCategory":{"type":"string","enum":["copilot","autonomous-agent","workflow-agent","rag-assistant","voice-agent"],"example":"copilot"},"DeploymentTier":{"type":"string","enum":["sandbox","pilot","production"],"example":"pilot"},"ArtifactCategory":{"type":"string","enum":["model_card","architecture_diagram","evaluation_report","compliance_certification","document"]},"OwningTeam":{"type":"object","required":["business_unit"],"properties":{"owning_team":{"type":"string","example":"Support Engineering"},"business_unit":{"type":"string","example":"Customer Success"},"cost_center":{"type":"string","example":"CC-4021"},"data_scope_precision":{"type":"string","description":"Controls how precisely the owning team appears in the catalog entry.","enum":["department-only","business-unit","org-wide"],"default":"business-unit"}}},"ComplianceCertification":{"type":"object","description":"Figures needed to publish a catalog entry.","properties":{"cert_type":{"type":"string","enum":["SOC2","ISO27001","GDPR","HIPAA"]},"assessment_method":{"type":"string","enum":["self_attested","third_party_audited"]},"guardrail_policy_attached":{"type":"string","example":"content-safety-v3"},"last_audit_year":{"type":"integer","example":2026},"data_classification_level":{"type":"string","enum":["public","internal","confidential","restricted"]},"valid_until":{"type":"string","format":"date","example":"2027-04-30"},"exemption":{"type":"string","description":"Set when no certification is currently required.","enum":["pilot_program","internal_only_no_external_data"]}}},"ChargebackInfo":{"type":"object","properties":{"rate_percent":{"type":"number","format":"float","example":12},"note":{"type":"string","example":"includes shared platform overhead"}}},"AgentInput":{"type":"object","required":["category","title","owning_team"],"properties":{"category":{"$ref":"#/components/schemas/AgentCategory"},"deployment_tier":{"$ref":"#/components/schemas/DeploymentTier"},"title":{"type":"string","maxLength":120,"example":"Internal Support Triage Copilot"},"description":{"type":"string","example":"Triages inbound support tickets and drafts first-response replies for human review."},"owning_team":{"$ref":"#/components/schemas/OwningTeam"},"integration_count":{"type":"integer","example":6},"tool_count":{"type":"integer","example":4},"model_provider":{"type":"string","example":"Anthropic Claude"},"model_release_date":{"type":"string","format":"date","example":"2026-02-01"},"cost_per_1k_tokens_usd":{"type":"number","format":"float","example":0.015},"monthly_budget_usd":{"type":"integer","example":4000},"support_budget_usd":{"type":"integer","example":500},"available_from":{"type":"string","format":"date","example":"2026-11-01"},"compliance_certification":{"$ref":"#/components/schemas/ComplianceCertification"},"chargeback":{"$ref":"#/components/schemas/ChargebackInfo"}}},"Agent":{"allOf":[{"$ref":"#/components/schemas/AgentInput"},{"type":"object","properties":{"id":{"type":"string","example":"agt_8f2c1a"},"status":{"$ref":"#/components/schemas/AgentStatus"},"artifact_count":{"type":"integer","example":14},"created_at":{"type":"string","format":"date-time","example":"2026-08-14T08:12:44Z"},"updated_at":{"type":"string","format":"date-time","example":"2026-08-20T09:38:02Z"}}}]},"Artifact":{"type":"object","properties":{"id":{"type":"string","example":"art_31c9"},"category":{"$ref":"#/components/schemas/ArtifactCategory"},"url":{"type":"string","format":"uri","example":"https://cdn.nexora.example/agents/agt_8f2c1a/art_31c9.pdf"},"order":{"type":"integer","example":1},"caption":{"type":"string","example":"Model card for the pilot deployment"},"size_bytes":{"type":"integer","example":2418112}}}}}}
```