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

# Spark Hire API

Spark Hire API for managing video interviews, jobs, users, question sets, share links, and webhooks. The API exposes 32 endpoints secured with basic authentication.

## For AI agents

Programmatically create new webhook, list all webhooks. Covers 32 operations with basic authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Create new webhook
- List all webhooks
- Delete webhook
- Get current user info
- Monitor Spark Hire API operational status and events

## Use cases

### Developer Tools Operations

Use the Spark Hire API to perform developer tools operations programmatically. The API provides 32 endpoints covering core functionality including create new webhook, list all webhooks, delete webhook.

Example prompt: Call POST /webhooks to create new webhook

### Automated Company Management

Automate company operations by combining multiple Spark Hire API endpoints. Agents can list all webhooks and then delete webhook in a single workflow.

Example prompt: Call GET /webhooks to list all webhooks, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Spark Hire 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 basic tokens manually.

Example prompt: Search Jentic for 'create new webhook', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/webhooks` | Create new webhook |
| GET | `/webhooks` | List all webhooks |
| DELETE | `/webhooks/{uuid}` | Delete webhook |
| GET | `/me` | Get current user info |
| POST | `/users` | Create company user |
| GET | `/users` | List company users |
| GET | `/users/{uuid}` | Get specific user |
| PUT | `/users/{uuid}` | Update user |

## Key resources

- **Company** — Operations related to Company
- **Interviews** — Operations related to Interviews
- **Jobs** — Operations related to Jobs
- **Question Sets** — Operations related to Question Sets
- **Share Links** — Operations related to Share Links

## Why Jentic

- **Setup:** Wiring Spark Hire by hand means encoding your basic auth credentials on every request and routing across users, jobs, interviews, and webhooks yourself. Through Jentic you install once, import the Spark Hire API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Spark Hire puts the resource uuid in the URL path (`/users/{uuid}`, `/interviews/{uuid}`, `/jobs/{uuid}`), so a rule can pin your agent to one interview or job: it reads and updates that resource and nothing else. You choose the operations it may call, so destructive ones like deleting a user or a job are not included unless you add them.
- **Credential handling:** Your Spark Hire credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create an interview' or 'list users', and Jentic returns the matching Spark Hire operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Spark Hire API use?

The Spark Hire API uses HTTP Basic authentication with username and password. 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 create new webhook with the Spark Hire API?

Yes. Use the POST /webhooks endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Spark Hire 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 create new webhook through Jentic?

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

### How many endpoints does the Spark Hire API have?

The Spark Hire API exposes 32 endpoints covering company, interviews, jobs operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Spark Hire operations and credentials the agent may use, and it can call only the ones you allow. Since Spark Hire puts the resource uuid in the URL path, such as `/users/{uuid}`, `/interviews/{uuid}`, and `/jobs/{uuid}`, a rule can pin the agent to a single interview or job so it reads and updates that resource and nothing else. Destructive calls like deleting a user or a job stay out of reach unless you explicitly add them.