> ## 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. # Get project integration ## OpenAPI ````yaml /api-reference/openapi.yaml get /orgs/{orgID}/projects/{projectID}/integrations/{integrationID} 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 - url: /api/v1 description: Self-hosted Omnara, relative to the deployment origin 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: Integrations description: >- Connect project integrations, route conversations, and manage launch settings. externalDocs: description: Guide url: https://docs.omnara.com/integrations/overview - 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}/integrations/{integrationID}: parameters: - name: orgID in: path required: true schema: $ref: '#/components/schemas/OrganizationID' - name: projectID in: path required: true schema: $ref: '#/components/schemas/ProjectID' - name: integrationID in: path required: true schema: $ref: '#/components/schemas/IntegrationID' get: tags: - Integrations summary: Get project integration operationId: getIntegration responses: '200': description: Get project integration. content: application/json: schema: $ref: '#/components/schemas/Integration' '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' 4XX: $ref: '#/components/responses/ClientError' 5XX: $ref: '#/components/responses/ServerError' components: schemas: OrganizationID: type: string pattern: ^org_[a-z2-7]{26}$ ProjectID: type: string pattern: ^proj_[a-z2-7]{26}$ IntegrationID: type: string pattern: ^itg_[a-z2-7]{26}$ Integration: type: object additionalProperties: false required: - id - project_id - name - integration_kind - state - setup_revision - settings - provider_agent_display_name - provider_config - capabilities - created_at - updated_at properties: id: $ref: '#/components/schemas/IntegrationID' project_id: $ref: '#/components/schemas/ProjectID' name: $ref: '#/components/schemas/IntegrationName' integration_kind: $ref: '#/components/schemas/IntegrationKind' state: $ref: '#/components/schemas/IntegrationState' setup_revision: type: integer x-go-type: int64 minimum: 1 description: >- Credential and transport revision. Launcher edits leave this value unchanged. last_oauth_flow_id: $ref: '#/components/schemas/IntegrationOAuthFlowID' runtime_failure: $ref: '#/components/schemas/IntegrationRuntimeFailure' settings: $ref: '#/components/schemas/IntegrationSettings' provider_tenant_id: type: string description: >- Verified provider identity, omitted until first connection. Retained after disconnect. provider_account_ref: type: string description: >- Verified provider account, omitted until first connection. Retained after disconnect. provider_agent_display_name: $ref: '#/components/schemas/IntegrationProviderDisplayName' bot_mention: type: string description: >- GitHub App mention including the leading @, derived from the verified App slug. Omitted when the verified slug is unavailable or the integration is not GitHub. Retained after disconnect. credential_secret_id: $ref: '#/components/schemas/SecretID' provider_config: $ref: '#/components/schemas/IntegrationProviderConfig' capabilities: $ref: '#/components/schemas/IntegrationCapabilities' created_at: $ref: '#/components/schemas/Timestamp' updated_at: $ref: '#/components/schemas/Timestamp' IntegrationName: type: string pattern: ^[a-zA-Z][a-zA-Z0-9-]{0,31}$ description: >- Immutable, project-unique integration name used in config keys and qualified tool names. IntegrationKind: type: string description: >- Registered integration implementation; independent of the saved integration's name and immutable ID. enum: - slack_thread - discord_thread - github_pr x-enum-varnames: - IntegrationKindSlackThread - IntegrationKindDiscordThread - IntegrationKindGitHubPR IntegrationState: type: string enum: - active - disconnected x-enum-varnames: - IntegrationStateActive - IntegrationStateDisconnected IntegrationOAuthFlowID: type: string pattern: ^ioaf_[a-z2-7]{26}$ IntegrationRuntimeFailure: type: object additionalProperties: false required: - message - retry_at description: >- Most recent connection failure for the active integration's current setup and credential version. Returned only by Get integration, not list or mutation responses. Omission does not establish provider connectivity; a runtime lease is not a connection check. properties: message: type: string description: Connection failure recorded by the integration runtime. retry_at: allOf: - $ref: '#/components/schemas/Timestamp' description: Earliest time the runtime may retry. A retry can start later. IntegrationSettings: type: object additionalProperties: true description: >- Integration-owned settings JSON. Validate against capabilities.settings.input_schema from the integration catalog. Public profile references use aprf_ IDs and resolve at runtime. IntegrationProviderDisplayName: type: string maxLength: 512 description: >- Provider account display label, at most 512 UTF-8 bytes. Leading and trailing whitespace is trimmed on save. Empty means no label; an omitted or empty value clears the label on account-management updates. SecretID: type: string pattern: ^sec_[a-z2-7]{26}$ IntegrationProviderConfig: type: object additionalProperties: true description: >- Non-secret provider configuration, validated for the selected provider. Slack and GitHub integrations require an empty object. Discord accepts only public_key (optional, a 32-byte hex-encoded Ed25519 verification key for interaction callbacks). Omnara manages one Gateway connection per Discord integration. Credentials and integration behavior are not accepted here. IntegrationCapabilities: type: object additionalProperties: false required: - tools properties: settings: $ref: '#/components/schemas/IntegrationCapabilityDefinition' description: >- Schema for this integration's complete settings document, including its optional launcher. tools: type: object additionalProperties: $ref: '#/components/schemas/IntegrationCapabilityDefinition' subscription: $ref: '#/components/schemas/IntegrationSubscriptionDefinition' description: >- Present when the integration supports forwarding from a conversation. The integration owns forwarding policy. interaction_handler: $ref: '#/components/schemas/IntegrationCapabilityDefinition' schedule: $ref: '#/components/schemas/IntegrationCapabilityDefinition' 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. current_digest: type: string pattern: ^sha256:[0-9a-f]{64}$ description: >- Current file digest for file_content_conflict or expected_digest_required; absent if the file no longer exists. A replacement must be confirmed before retrying with this digest. issues: type: array description: >- Field-level problems when a submitted document (such as an agent config source) failed validation. Absent for errors that are not about a specific field. items: $ref: '#/components/schemas/AgentConfigErrorIssue' code: type: string description: Stable error code for programmatic handling. x-go-type: ErrorCode x-extensible-enum: - invalid_request - unauthorized - forbidden - not_found - conflict - file_content_conflict - file_read_only - expected_digest_required - not_a_file - gone - request_too_large - unsupported_media_type - unprocessable - upstream_unavailable - rate_limited - internal_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. x-extensible-enum: - invalid_request - validation_failed - unauthorized - forbidden - csrf_check_failed - not_found - conflict - file_content_conflict - file_read_only - expected_digest_required - not_a_file - idempotency_key_conflict - state_transition_conflict - pending_work - not_wake_capable - gone - daemon_runtime_unregistered - request_too_large - unsupported_media_type - unprocessable - upstream_unavailable - rate_limited ServerErrorCode: type: string description: >- Stable error code carried by 5XX statuses. Subset of the Error code enum whose statuses are server errors. x-extensible-enum: - internal_error - service_unavailable - authentication_unavailable IntegrationCapabilityDefinition: type: object additionalProperties: false required: - input_schema properties: description: type: string input_schema: type: object additionalProperties: true description: >- Static argument schema for this operation or interaction handler. Shipped integration tools accept action arguments and use the conversation assigned at launch; execution fails if no conversation is assigned. Shipped interaction handlers use the assigned conversation and accept empty arguments. IntegrationSubscriptionDefinition: type: object additionalProperties: false required: - conversation_schema properties: conversation_schema: type: object additionalProperties: true description: Schema for one concrete provider conversation address. AgentConfigErrorIssue: type: object additionalProperties: false required: - path - message properties: path: type: string description: >- JSON Pointer (RFC 6901) to the offending field in the submitted document. An empty string refers to the whole document. message: type: string description: Human-readable description of the problem with this field. line: type: integer minimum: 1 description: >- 1-based line of the offending field in the submitted source, when it can be located. column: type: integer minimum: 1 description: >- 1-based column of the offending field in the submitted source, when it can be located. 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' 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.