Search
K
Access & Onboarding Requests

Access & Onboarding Requests

1.0.0OAS 3.0

Accepts requests from internal teams to gain access to an agent, maintains
each requester’s capability profile and matches the two automatically.
Every request gets a traceable score, so that limited evaluation-session
slots go to the right requests.

Request data is personal. Every record therefore carries a
retention_until; once it passes, the record is anonymized overnight. A
deletion request is carried out immediately via POST /requests/{id}/deletion.

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

Requests

List access requests

get

Query Parameters

capability_profile_activeboolean
statusstring

Allowed values:newscoredinviteddeclinedclosed

Example:scored

limitinteger

Default:25

>= 1<= 100

cursorstring

Response

application/json

Results list

dataarray
Show Child Parameters
pageobject

Cursor-based pagination.

Show Child Parameters
get/requests
 
application/json

Log an access request

Typically called from the internal service catalog’s request form.

post

Body

application/json

AccessRequestInput

requester_first_namestring

Example:Anna

requester_last_namestringrequired

Example:Bergmann

emailstring(email)required

Example:a.bergmann@nexora.example

business_unitstring

Example:Revenue Operations

consentobjectrequired

Record of consent under applicable data protection policy.

Show Child Parameters
requested_capability_profileobject
Show Child Parameters

Response

application/json

Logged

AccessRequest

requester_first_namestring

Example:Anna

requester_last_namestringrequired

Example:Bergmann

emailstring(email)required

Example:a.bergmann@nexora.example

business_unitstring

Example:Revenue Operations

consentobjectrequired

Record of consent under applicable data protection policy.

Show Child Parameters
requested_capability_profileobject
Show Child Parameters
idstring

Example:req_71ab

statusstring

Allowed values:newscoredinviteddeclinedclosed

Example:scored

retention_untilstring(date)

Automatically set deletion deadline. Anonymized after it passes.

Example:2027-02-18

created_atstring(date-time)

Example:2026-08-18T10:22:04Z

post/requests

Body

{ "requester_first_name": "Anna", "requester_last_name": "Bergmann", "email": "a.bergmann@nexora.example", "business_unit": "Revenue Operations", "consent": { "purpose": "access_grant", "granted_at": "2026-08-18T10:22:00Z" }, "requested_capability_profile": { "agent_categories": [ "copilot", "workflow-agent" ], "business_units": [ "Revenue Operations" ], "min_integration_count": 3, "max_cost_per_1k_tokens_usd": 0.02, "requires_compliance_certification": true } }
 
application/json

Retrieve an access request

get

Path Parameters

requestIdstringrequired

Example:req_71ab

Response

application/json

Access request

AccessRequest

requester_first_namestring

Example:Anna

requester_last_namestringrequired

Example:Bergmann

emailstring(email)required

Example:a.bergmann@nexora.example

business_unitstring

Example:Revenue Operations

consentobjectrequired

Record of consent under applicable data protection policy.

Show Child Parameters
requested_capability_profileobject
Show Child Parameters
idstring

Example:req_71ab

statusstring

Allowed values:newscoredinviteddeclinedclosed

Example:scored

retention_untilstring(date)

Automatically set deletion deadline. Anonymized after it passes.

Example:2027-02-18

created_atstring(date-time)

Example:2026-08-18T10:22:04Z

get/requests/{requestId}
 
application/json