The objects you work with
What you can build
- Submit work and read results. Send an input to an engine, poll the run or receive a webhook, and read a typed output. See Engines and Runs.
- Add a conversational assistant. Configure a conversation instance in the portal and stream turns from your application. See Conversations.
- Read your connected data. Nexio connects to a document library, a warehouse or an API, extracts and serves typed records, and answers authorized reads for a person in your organization. See Connections and data and Records.
- React to events. Receive signed webhooks when runs finish, and send your own events into Nexio. See Events and webhooks.
Build in this order
1
Authenticate
Create an API key in the portal for a sandbox environment. A sandbox key works for engines, runs, conversations and webhooks. Records (
/records, /actions) and graph (/api/v1/graph) refuse a sandbox key with 403 (CAPABILITY_DENIED, reason SCOPED_KEY_REQUIRED, on Records; scoped_key_required on graph): call them with your organization’s live key or with a scoped key Nexio issues. See Authentication and access and Environments.2
Configure
Pick or configure an engine or a conversation instance. See Engine configuration.
3
Submit
Send a run or a conversation turn. See the Quickstart.
4
Poll or receive
Poll the run until it reaches a terminal status, or register a webhook.
5
Read results
Read the output and, where the engine provides one, its defensibility packet.
6
Review and improve
Record outcomes and annotations so reviewers and evaluations can measure and improve the engine.
Next
Quickstart
Make your first authenticated call and read a run result.
Platform model
See each primitive, how they connect, and what you configure.
Authentication and access
Learn which key you need for which route.
API reference
Browse the documented endpoints. The
runs/latest routes, which are bound to platform engines, are not documented.OpenAPI definition
Download the machine-readable interface definition for the documented endpoints.
Security and compliance
See where your data goes, how it is encrypted and how long it is kept.