> ## Documentation Index > Fetch the complete documentation index at: https://docs.omnara.com/llms.txt > Use this file to discover all available pages before exploring further. # Update agent profile ## OpenAPI ````yaml /api-reference/openapi.yaml post /orgs/{orgID}/projects/{projectID}/agent-profiles/{agentProfileID}/config openapi: 3.1.2 info: title: Omnara API version: 0.1.0 description: Public HTTP API contract for Omnara. servers: - url: https://api.omnara.com/v1 description: Hosted Omnara security: - bearerAuth: [] - browserSessionCookie: [] tags: - name: Agents description: >- Launch agents, send inputs, manage the input backlog, and work with tool calls. externalDocs: description: Guide url: https://docs.omnara.com/agents/overview - name: Interactions description: List and resolve the approvals and questions that pause an agent. externalDocs: description: Guide url: https://docs.omnara.com/events/interactions - name: Actors description: Attribute agent inputs and interaction responses to external users. externalDocs: description: Guide url: >- https://docs.omnara.com/events/sending-input#who-said-that-actors-and-attribution - name: Events description: Read or stream the agent timeline, list turns, and download artifacts. externalDocs: description: Guide url: https://docs.omnara.com/events/streaming - name: Configs and Profiles description: >- Create agent configs, manage reusable launch profiles, and set up integrations. externalDocs: description: Guide url: https://docs.omnara.com/agents/configuration - name: Models description: Configure model providers and models, and grant projects access to them. externalDocs: description: Guide url: https://docs.omnara.com/organization/model-providers - name: Machines description: Register machines, control project access, and manage daemon tokens. externalDocs: description: Guide url: https://docs.omnara.com/machines/connect - name: Machine Pools description: Define machine pools and grant projects access to them. externalDocs: description: Guide url: https://docs.omnara.com/machines/pools - name: Secrets description: >- Manage secret ownership and versions, and inspect or grant project availability. externalDocs: description: Guide url: https://docs.omnara.com/organization/secrets - name: Skills description: Manage versioned skill ownership and load skill instructions on demand. externalDocs: description: Guide url: https://docs.omnara.com/tools/skills - name: Organizations and Projects description: Create organizations and projects and manage membership. externalDocs: description: Guide url: https://docs.omnara.com/organization/members - name: Users and API Keys description: >- The authenticated user, personal and organization API keys, and invitations. externalDocs: description: Guide url: https://docs.omnara.com/api/authentication - name: Machine Daemon description: Routes the Omnara machine daemon uses to connect a machine. paths: /orgs/{orgID}/projects/{projectID}/agent-profiles/{agentProfileID}/config: parameters: - name: orgID in: path required: true schema: type: string pattern: ^org_[a-z2-7]{26}$ - name: projectID in: path required: true schema: type: string pattern: ^proj_[a-z2-7]{26}$ - name: agentProfileID in: path required: true schema: type: string pattern: ^aprf_[a-z2-7]{26}$ post: tags: - Configs and Profiles summary: Update agent profile operationId: updateAgentProfile parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAgentProfileRequest' responses: '200': description: Agent profile updated. content: application/json: schema: $ref: '#/components/schemas/AgentProfile' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '503': $ref: '#/components/responses/ServiceUnavailable' 4XX: $ref: '#/components/responses/ClientError' 5XX: $ref: '#/components/responses/ServerError' security: - bearerAuth: [] - browserSessionCookie: [] csrfHeader: [] components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false schema: type: string minLength: 1 maxLength: 255 description: Idempotency key for replay-safe mutating requests. schemas: UpdateAgentProfileRequest: type: object additionalProperties: false required: - config - expected_current_config_id properties: config: $ref: '#/components/schemas/AgentConfigID' expected_current_config_id: $ref: '#/components/schemas/AgentConfigID' AgentProfile: type: object additionalProperties: false required: - id - org_id - project_id - name - current_config_id - current_generation - current_config - created_at - updated_at properties: id: $ref: '#/components/schemas/AgentProfileID' org_id: $ref: '#/components/schemas/OrganizationID' project_id: $ref: '#/components/schemas/ProjectID' name: $ref: '#/components/schemas/ResourceName' current_config_id: $ref: '#/components/schemas/AgentConfigID' current_generation: type: integer format: int32 current_config: $ref: '#/components/schemas/AgentConfig' created_at: $ref: '#/components/schemas/Timestamp' updated_at: $ref: '#/components/schemas/Timestamp' AgentConfigID: type: string pattern: ^acfg_[a-z2-7]{26}$ AgentProfileID: type: string pattern: ^aprf_[a-z2-7]{26}$ OrganizationID: type: string pattern: ^org_[a-z2-7]{26}$ ProjectID: type: string pattern: ^proj_[a-z2-7]{26}$ ResourceName: type: string minLength: 1 maxLength: 64 x-omnara-unicode-normalization: NFC description: >- Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not. AgentConfig: type: object additionalProperties: false required: - id - org_id - project_id - effective_definition_hash - model - created_at properties: id: $ref: '#/components/schemas/AgentConfigID' org_id: $ref: '#/components/schemas/OrganizationID' project_id: $ref: '#/components/schemas/ProjectID' source: type: string source_format: type: string enum: - yaml - json compiler_version: type: string effective_definition_hash: type: string model: $ref: '#/components/schemas/AgentConfigModel' instruction_hash: type: string warnings: type: array minItems: 1 x-go-type-skip-optional-pointer: true description: Non-blocking diagnostics about the agent config. items: $ref: '#/components/schemas/Warning' created_at: $ref: '#/components/schemas/Timestamp' Timestamp: type: string format: date-time Error: type: object additionalProperties: false required: - error - code properties: error: type: string description: Human-readable error message. Do not match on it programmatically. code: type: string description: Stable error code for programmatic handling. enum: - invalid_request - unauthorized - forbidden - not_found - conflict - gone - request_too_large - unsupported_media_type - unprocessable - rate_limited - internal_error - upstream_error - service_unavailable - idempotency_key_conflict - state_transition_conflict - managed_work_admission_denied - pending_work - not_wake_capable - daemon_runtime_unregistered - validation_failed - csrf_check_failed - authentication_unavailable ClientErrorCode: type: string description: >- Stable error code carried by 4XX statuses. Subset of the Error code enum whose statuses are client errors. enum: - invalid_request - validation_failed - unauthorized - forbidden - csrf_check_failed - not_found - conflict - idempotency_key_conflict - state_transition_conflict - pending_work - not_wake_capable - gone - daemon_runtime_unregistered - request_too_large - unsupported_media_type - unprocessable - rate_limited ServerErrorCode: type: string description: >- Stable error code carried by 5XX statuses. Subset of the Error code enum whose statuses are server errors. enum: - internal_error - upstream_error - service_unavailable - authentication_unavailable AgentConfigModel: type: object additionalProperties: false required: - provider_config - name - provider_model_slug - configured_model_id - current_revision_id - api_format - api_variant - context_window_tokens - max_output_tokens - default_cache_retention - supports_tools - supports_reasoning - default_reasoning_effort - supported_reasoning_efforts - input_modalities - output_modalities properties: provider_config: $ref: '#/components/schemas/ResourceName' name: $ref: '#/components/schemas/ResourceName' description: >- Configured model name selected by this agent config, rendered from the current configured model record. provider_model_slug: type: string description: >- Exact provider model slug on the configured model's current revision at response time. configured_model_id: $ref: '#/components/schemas/ConfiguredModelID' current_revision_id: $ref: '#/components/schemas/ConfiguredModelRevisionID' api_format: $ref: '#/components/schemas/ModelAPIFormat' api_variant: $ref: '#/components/schemas/ModelProviderAPIVariantResponse' context_window_tokens: type: integer description: >- Effective token window after configured-model, project-grant, and agent-config settings are applied. max_output_tokens: type: integer description: >- Effective largest output-token cap Omnara allows for this agent config. default_max_output_tokens: type: - integer - 'null' description: Effective per-request output-token cap sent to the provider. default_cache_retention: $ref: '#/components/schemas/ModelCacheRetention' supports_tools: type: boolean supports_reasoning: type: boolean default_reasoning_effort: type: string supported_reasoning_efforts: type: array items: type: string input_modalities: type: array items: type: string output_modalities: type: array items: type: string Warning: type: object additionalProperties: false required: - message - code properties: message: type: string description: Human-readable warning message. Do not match on it programmatically. code: type: string description: Stable warning code for programmatic handling. enum: - missing_recommended_machine_tools ConfiguredModelID: type: string pattern: ^mdl_[a-z2-7]{26}$ ConfiguredModelRevisionID: type: string pattern: ^mrev_[a-z2-7]{26}$ ModelAPIFormat: type: string enum: - openai-responses - openai-chat-completions - anthropic-messages x-enum-varnames: - ModelAPIFormatOpenaiResponses - ModelAPIFormatOpenaiChatCompletions - ModelAPIFormatAnthropicMessages ModelProviderAPIVariantResponse: type: string x-extensible-enum: - default - openrouter - bedrock ModelCacheRetention: type: string description: >- Default prompt-cache hint for model requests. `none` means Omnara does not send a cache hint; providers may still apply their own automatic caching. `short` and `long` are translated to the closest supported control for the selected API. enum: - none - short - long responses: BadRequest: description: The request was invalid. content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Authentication is required or invalid. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: The authenticated principal is not authorized. content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: The requested resource was not found or is not visible. content: application/json: schema: $ref: '#/components/schemas/Error' Conflict: description: >- The request conflicts with current resource state or idempotency history. content: application/json: schema: $ref: '#/components/schemas/Error' ServiceUnavailable: description: The service dependency required to satisfy the request is unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' ClientError: description: >- Any other client error. The body carries the shared Error envelope restricted to client error codes; statuses with a dedicated response above are documented precisely. content: application/json: schema: type: object additionalProperties: false required: - error - code properties: error: type: string description: >- Human-readable error message. Do not match on it programmatically. code: $ref: '#/components/schemas/ClientErrorCode' ServerError: description: >- Any other server error. The body carries the shared Error envelope restricted to server error codes. content: application/json: schema: type: object additionalProperties: false required: - error - code properties: error: type: string description: >- Human-readable error message. Do not match on it programmatically. code: $ref: '#/components/schemas/ServerErrorCode' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Omnara personal or organization access token description: An opaque Omnara personal or organization bearer token. browserSessionCookie: type: apiKey in: cookie name: __Host-omnara_session description: >- Browser session cookie. HTTPS deployments use __Host-omnara_session; local HTTP development uses omnara_session. csrfHeader: type: apiKey in: header name: X-Omnara-Csrf description: >- CSRF token header required for browser-session mutations. The value must match the session's CSRF cookie. ````