Search
K
Agent Catalog

Agent Catalog

1.0.0OAS 3.0

Turns structured agent metadata into a finished catalog entry - as a
governance record and as a portal-style web view - and publishes it to
the internal Agent Catalog.

A catalog entry always references exactly one agent from Agent
Deployments. Standalone catalog entries without a deployment record are
intentionally not supported, so compliance disclosures and rollout
history stay maintained in a single place.

Workflow

  1. POST /catalog-entries starts the generation. The response carries status: "in_progress".
  2. Once the entry is ready, the status changes to completed. We recommend
    subscribing to the catalog_entry.completed event instead of polling.
  3. GET /catalog-entries/{entryId}/record returns the document.
  4. POST /catalog-entries/{entryId}/publish puts it live in the internal catalog.

Compliance disclosures

Before publication the API checks the disclosures required by governance
policy - most importantly the compliance-certification figures and the
chargeback rate. If something is missing, the API responds with 422 and
code: "compliance_disclosure_missing".

API Base URL
  • Server 1:https://api.nexora.example/v1

    Production

  • Server 2:https://sandbox.api.nexora.example/v1

    Sandbox

Security
apiKey (apiKey)

Every call carries an API key in the apikey header. You generate the
key in the Nexora AI portal under “My Apps”; it’s shown exactly once.

Each key has the scopes it’s allowed to use attached to it. If one is
missing, the API responds with 403 and code: "scope_missing"; the
missing scope is in details[].field.

Additional Information
Contact API Support - Nexora AI (api-support@nexora.example)

For demonstration purposes only License

Catalog Entries

List catalog entries

Returns the catalog’s entries, optionally filtered by agent and status.

get

Query Parameters

agent_idstring

Only entries for this agent.

Example:agt_8f2c1a

statusstring

Lifecycle of a catalog entry.

Allowed values:in_progresscompletedpublishedwithdrawnfailed

Example:completed

limitinteger

Default:25

>= 1<= 100

cursorstring

Cursor from page.next_cursor of the previous response.

Response

application/json

Results list

dataarray[object]
Show Child Parameters
pageobject

Cursor-based pagination.

Show Child Parameters
get/catalog-entries
 
application/json

Create a catalog entry

Starts the generation of a catalog entry from an agent and a
template. Processing runs asynchronously; the response initially
carries status: "in_progress".

post

Body

application/json

CreateCatalogEntryRequest

agent_idstringrequired

Agent the catalog entry is generated from.

Example:agt_8f2c1a

template_idstringrequired

Design template of the catalog.

Example:tpl_standard

target_teamstring

Audience the entry is written for.

Allowed values:engineeringproductsupportsales-opscompliance-legalopen

Default:open

sectionsarray[string]

Content block of the catalog entry.

Allowed values:capabilitiesdata_scopeintegrationscompliancetarget_teamsrollout_history

internal_notestring

Internal remark; does not appear in the record.

<= 500 characters

Example:Owner wants the pilot renewed before the entry goes live org-wide.

Response

application/json

Generation accepted

CatalogEntry

idstring

Example:entry_4d9b2e

agent_idstring

Example:agt_8f2c1a

template_idstring

Example:tpl_standard

target_teamstring

Audience the entry is written for.

Allowed values:engineeringproductsupportsales-opscompliance-legalopen

Default:open

statusstring

Lifecycle of a catalog entry.

Allowed values:in_progresscompletedpublishedwithdrawnfailed

Example:completed

record_urlstring(uri)

Only set once status: completed. The link is valid for 24 hours.

Example:https://api.nexora.example/v1/catalog-entries/entry_4d9b2e/record

pagesinteger

Page count of the generated record.

Example:4

disclosuresobject

Result of the compliance-disclosure check.

Show Child Parameters
created_atstring(date-time)

Example:2026-08-20T09:41:12Z

completed_atstring | null(date-time)

Example:2026-08-20T09:41:20Z

post/catalog-entries

Body

{ "agent_id": "agt_8f2c1a", "template_id": "tpl_standard", "target_team": "engineering", "sections": [ "capabilities", "data_scope", "integrations", "compliance" ] }
 
application/json

Retrieve a catalog entry

Returns status, metadata and the compliance-disclosure report.

get

Path Parameters

entryIdstringrequired

Identifier of the catalog entry.

Example:entry_4d9b2e

Response

application/json

Catalog entry

CatalogEntry

idstring

Example:entry_4d9b2e

agent_idstring

Example:agt_8f2c1a

template_idstring

Example:tpl_standard

target_teamstring

Audience the entry is written for.

Allowed values:engineeringproductsupportsales-opscompliance-legalopen

Default:open

statusstring

Lifecycle of a catalog entry.

Allowed values:in_progresscompletedpublishedwithdrawnfailed

Example:completed

record_urlstring(uri)

Only set once status: completed. The link is valid for 24 hours.

Example:https://api.nexora.example/v1/catalog-entries/entry_4d9b2e/record

pagesinteger

Page count of the generated record.

Example:4

disclosuresobject

Result of the compliance-disclosure check.

Show Child Parameters
created_atstring(date-time)

Example:2026-08-20T09:41:12Z

completed_atstring | null(date-time)

Example:2026-08-20T09:41:20Z

get/catalog-entries/{entryId}
 
application/json