> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Register an engine > Adding an engine is a configuration operation, not a software delivery. credentialSubject is globally unique. ## OpenAPI ````yaml /pt/openapi/v3-current/jd-courier.yaml post /v1/engines openapi: 3.1.0 info: description: >- The JD Courier API. Operators use it to manage the engines, the ownership map, the delivery modes and bypass of each rail, the retained messages, the SPB send journal and reconciliation. Engines use it to resolve the owner of a key, claim their Pix Automático recurrences and declare their Pix Automático payment legs. title: JD Courier API version: v1.0.0 servers: [] security: - BearerAuth: [] tags: - description: >- The engine registry: the cores that consume the JD channel through the Courier, each with its participant set name: Engines - description: 'The ownership map: which engine owns each key. Every change is audited.' name: ownership - description: >- The rails: what each declares about itself, its state per tenant, and the bypass declaration name: channels - description: >- The engines' side of the ownership map: resolution for the on-us gate, authoritative and never advisory, the claim of a Pix Automático recurrence the engine holds, and the declaration of a payment leg it holds. name: ownership-query - description: >- The durable message store: redelivery on demand, without asking the vendor again name: ledger - description: >- Count reconciliation per rail: E(m) = C(m) + T(m) + R(m), the sequence gaps it saw, and the sends whose return leg never arrived name: assurance - description: >- The SPB send journal: every send, written before it leaves, and the sends whose outcome is unknown. A by-hand close records an operator's finding and never resends. name: send-journal - description: >- Per-(tenant, channel) state an operator acts on: lifting a durable channel halt name: channel-leases - description: >- Messages the Courier holds because no engine could receive them. A routing or delivery retention leaves by itself once its cause lifts, or when an operator asks for its routing decision to be run again. name: retained paths: /v1/engines: post: tags: - Engines summary: Register an engine description: >- Adding an engine is a configuration operation, not a software delivery. credentialSubject is globally unique. operationId: registerEngine parameters: - description: >- Idempotency key; a retry with the same key and body replays the first answer. in: header name: X-Idempotency required: true schema: description: >- Idempotency key; a retry with the same key and body replays the first answer. type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterEngineRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Engine' description: Created '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Bad Request '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Forbidden '409': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Conflict '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error '503': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Service Unavailable components: schemas: RegisterEngineRequest: additionalProperties: false properties: credentialSubject: maxLength: 256 minLength: 1 type: string displayName: maxLength: 128 type: string engineId: pattern: ^[a-z0-9-]{1,32}$ type: string participants: description: >- The direct-participant ISPBs this engine acts as. Omitted or empty is legal, and an ISPB another engine already declares is accepted: a shared ISPB across two cores is the coexistence case itself. items: pattern: ^[0-9]{8}$ type: string type: - array - 'null' pixDelivery: $ref: '#/components/schemas/PixDeliveryTarget' description: >- Where the Courier delivers the Pix messages the ownership map gives this engine; https in production, and setting it needs the admin grant (engines pix-delivery:write). Omitted: the engine takes none, and such a message is retained. required: - engineId - credentialSubject type: object Engine: additionalProperties: false properties: createdAt: format: date-time type: string credentialSubject: maxLength: 256 type: string disabledAt: format: date-time type: - string - 'null' displayName: maxLength: 128 type: string enabled: type: boolean engineId: pattern: ^[a-z0-9-]{1,32}$ type: string participants: items: pattern: ^[0-9]{8}$ type: string type: array pixDelivery: $ref: '#/components/schemas/PixDeliveryTarget' required: - engineId - displayName - enabled - credentialSubject - participants - createdAt type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object PixDeliveryTarget: additionalProperties: false properties: baseUrl: description: >- The engine's Pix address, absolute http(s). The vendor's route path is appended verbatim. Empty on an update removes the target. maxLength: 2048 type: string credentialRef: description: >- A reference to the Courier's own client credential at the engine: the id of a versioned secret under this tenant, jd-courier and this engine. Never the secret itself. Omitted: delivered with no credential. maxLength: 512 type: string required: - baseUrl type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.