canonical: https://jentic.com/apis/spotdraft.com/spotdraft

# SpotDraft API

SpotDraft Public API API Reference The SpotDraft API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has predictable resource-oriented URLs, accepts [form-encoded](<https://en.wikipedia.org/wiki/POST_(HTTP)#Use_for_submitting_web_forms>) request bodies, returns [JSON-encoded](http://www.json.org/) responses, and uses standard HTTP response codes, a. The API exposes 134 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get roles, create user. Covers 134 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for ai and machine learning only.

## Capabilities

- Get Roles
- Create User
- Update User roles
- Deactivate a User
- Monitor SpotDraft API operational status and events

## Use cases

### AI and Machine Learning Operations

Use the SpotDraft API to perform ai ml operations programmatically. The API provides 134 endpoints covering core functionality including get roles, create user, get user list.

Example prompt: Call GET `/v1/public/auth/roles` to get roles

### Automated V2.1 Contract APIs Management

Automate v2.1 contract apis operations by combining multiple SpotDraft API endpoints. Agents can create user and then get user list in a single workflow.

Example prompt: Call POST `/v1/public/auth/users` to create user, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call SpotDraft API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get roles', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v1/public/auth/roles` | Get Roles |
| POST | `/v1/public/auth/users` | Create User |
| GET | `/v1/public/auth/users` | Get User List |
| PATCH | `/v1/public/auth/users/{user_id}` | Update User roles |
| DELETE | `/v1/public/auth/users/{user_id}` | Deactivate a User |
| POST | `/v1/public/contracts` | Create Contract |
| GET | `/v1/public/contracts` | Get Contract List |
| GET | `/v1/public/contracts/by_external_metadata/{external_metadata_id}` | Get Contract by External Metadata ID |

## Key resources

- **V2.1 Contract APIs** — Operations related to V2.1 Contract APIs
- **V2 Contract APIs** — Operations related to V2 Contract APIs
- **V2.1 Counterparty APIs** — Operations related to V2.1 Counterparty APIs
- **V2 Counterparty APIs** — Operations related to V2 Counterparty APIs
- **V1 Contract APIs** — Operations related to V1 Contract APIs

## Why Jentic

- **Setup:** Wiring the SpotDraft API by hand means provisioning its API key, attaching it to every request, and pointing calls at the api.spotdraft.com/api host yourself. Through Jentic you install once, import the SpotDraft API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** SpotDraft puts the user id in the URL path (`/v1/public/auth/users/{user_id}`), so a rule can pin your agent to one user record. You choose the operations it may call, so destructive ones like deleting a user are not included unless you add them.
- **Credential handling:** Your SpotDraft API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list roles' or 'create a contract', and Jentic returns the matching SpotDraft API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Openai** — Alternative ai ml API
- **Anthropic** — Alternative ai ml API
- **Cohere** — Complementary ai ml API
- **Huggingface** — Complementary ai ml API

## FAQ

### What authentication does the SpotDraft API use?

The SpotDraft API uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get roles with the SpotDraft API?

Yes. Use the GET `/v1/public/auth/roles` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the SpotDraft API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get roles through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get roles'. Jentic returns the matching SpotDraft API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the SpotDraft API have?

The SpotDraft API exposes 134 endpoints covering v2.1 contract apis, v2 contract apis, v2.1 counterparty apis operations.

### Can I limit what my agent is allowed to do with the SpotDraft API?

Yes. Because you run Jentic One yourself, your own rules decide which SpotDraft operations and credentials the agent may use, so you can grant read-only calls like GET `/v1/public/auth/roles` or GET `/v1/public/contracts` while withholding destructive ones such as DELETE `/v1/public/auth/users/{user_id}.` Since SpotDraft puts the user id in the URL path, a rule can pin the agent to a single user record. The agent can only ever call the operations you have explicitly allowed.