productivity
Ashby CLI for AI Agents
Use the Ashby CLI from KosmoKrator to call Ashby tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.Ashby CLI Setup
Ashby can be configured headlessly with `kosmokrator integrations:configure ashby`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure ashby --set access_token="$ASHBY_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor ashby --json
kosmokrator integrations:status --json Credentials
Authentication type: basic api key basic_api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
access_token | ASHBY_ACCESS_TOKEN | Secret secret | yes | API Key |
url | ASHBY_URL | URL url | no | API Base URL |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call ashby.ashby_api_post '{}' --json kosmo integrations:ashby ashby_api_post '{}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs ashby --json
kosmo integrations:docs ashby.ashby_api_post --json
kosmo integrations:schema ashby.ashby_api_post --json
kosmo integrations:search "Ashby" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
ashby.ashby_api_post
Call any Ashby RPC API endpoint.
write - Parameters
- none
kosmo integrations:call ashby.ashby_api_post '{}' --json kosmo integrations:ashby ashby_api_post '{}' --json ashby.ashby_get_current_user
Get the profile of the currently authenticated Ashby user. Use this to verify API access and see user details.
read - Parameters
- none
kosmo integrations:call ashby.ashby_get_current_user '{}' --json kosmo integrations:ashby ashby_get_current_user '{}' --json ashby.ashby_list_users
List Ashby users.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_users '{}' --json kosmo integrations:ashby ashby_list_users '{}' --json ashby.ashby_list_candidates
List candidates from Ashby with cursor pagination and sync tokens. Use ashby_search_candidates for name or email lookups.
read - Parameters
- createdAfter, cursor, syncToken, limit
kosmo integrations:call ashby.ashby_list_candidates '{"createdAfter":1,"cursor":"example_cursor","syncToken":"example_syncToken","limit":1}' --json kosmo integrations:ashby ashby_list_candidates '{"createdAfter":1,"cursor":"example_cursor","syncToken":"example_syncToken","limit":1}' --json ashby.ashby_search_candidates
Search candidates by name or email.
read - Parameters
- none
kosmo integrations:call ashby.ashby_search_candidates '{}' --json kosmo integrations:ashby ashby_search_candidates '{}' --json ashby.ashby_get_candidate
Get a single candidate.
read - Parameters
- none
kosmo integrations:call ashby.ashby_get_candidate '{}' --json kosmo integrations:ashby ashby_get_candidate '{}' --json ashby.ashby_create_candidate
Create a candidate.
write - Parameters
- none
kosmo integrations:call ashby.ashby_create_candidate '{}' --json kosmo integrations:ashby ashby_create_candidate '{}' --json ashby.ashby_update_candidate
Update a candidate.
write - Parameters
- none
kosmo integrations:call ashby.ashby_update_candidate '{}' --json kosmo integrations:ashby ashby_update_candidate '{}' --json ashby.ashby_create_note
Create a note in Ashby attached to a candidate, application, or job. Notes are visible to the hiring team and appear in activity feeds.
write - Parameters
- candidateId, content, contentType
kosmo integrations:call ashby.ashby_create_note '{"candidateId":"example_candidateId","content":"example_content","contentType":"example_contentType"}' --json kosmo integrations:ashby ashby_create_note '{"candidateId":"example_candidateId","content":"example_content","contentType":"example_contentType"}' --json ashby.ashby_list_candidate_notes
List notes for a candidate.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_candidate_notes '{}' --json kosmo integrations:ashby ashby_list_candidate_notes '{}' --json ashby.ashby_list_applications
List job applications in Ashby. Returns applications with candidate info, status, and associated job. Use filters to narrow by job or status.
read - Parameters
- limit, offset, job_id, status
kosmo integrations:call ashby.ashby_list_applications '{"limit":1,"offset":1,"job_id":"example_job_id","status":"example_status"}' --json kosmo integrations:ashby ashby_list_applications '{"limit":1,"offset":1,"job_id":"example_job_id","status":"example_status"}' --json ashby.ashby_get_application
Get detailed information about a specific job application in Ashby, including candidate details, status, and evaluation data.
read - Parameters
- id
kosmo integrations:call ashby.ashby_get_application '{"id":"example_id"}' --json kosmo integrations:ashby ashby_get_application '{"id":"example_id"}' --json ashby.ashby_create_application
Create an application for a candidate and job.
write - Parameters
- none
kosmo integrations:call ashby.ashby_create_application '{}' --json kosmo integrations:ashby ashby_create_application '{}' --json ashby.ashby_update_application
Update an application.
write - Parameters
- none
kosmo integrations:call ashby.ashby_update_application '{}' --json kosmo integrations:ashby ashby_update_application '{}' --json ashby.ashby_list_criteria_evaluations
List AI criteria evaluations for an application.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_criteria_evaluations '{}' --json kosmo integrations:ashby ashby_list_criteria_evaluations '{}' --json ashby.ashby_list_jobs
List job postings in Ashby. Returns open and closed positions with department, location, and application count. Filter by status to find active openings.
read - Parameters
- limit, offset, status
kosmo integrations:call ashby.ashby_list_jobs '{"limit":1,"offset":1,"status":"example_status"}' --json kosmo integrations:ashby ashby_list_jobs '{"limit":1,"offset":1,"status":"example_status"}' --json ashby.ashby_search_jobs
Search jobs.
read - Parameters
- none
kosmo integrations:call ashby.ashby_search_jobs '{}' --json kosmo integrations:ashby ashby_search_jobs '{}' --json ashby.ashby_get_job
Get detailed information about a specific job in Ashby, including full description, requirements, compensation, and hiring team.
read - Parameters
- id
kosmo integrations:call ashby.ashby_get_job '{"id":"example_id"}' --json kosmo integrations:ashby ashby_get_job '{"id":"example_id"}' --json ashby.ashby_create_job
Create a job.
write - Parameters
- none
kosmo integrations:call ashby.ashby_create_job '{}' --json kosmo integrations:ashby ashby_create_job '{}' --json ashby.ashby_update_job
Update a job.
write - Parameters
- none
kosmo integrations:call ashby.ashby_update_job '{}' --json kosmo integrations:ashby ashby_update_job '{}' --json ashby.ashby_list_job_postings
List job postings.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_job_postings '{}' --json kosmo integrations:ashby ashby_list_job_postings '{}' --json ashby.ashby_get_job_posting
Get a job posting.
read - Parameters
- none
kosmo integrations:call ashby.ashby_get_job_posting '{}' --json kosmo integrations:ashby ashby_get_job_posting '{}' --json ashby.ashby_list_openings
List openings.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_openings '{}' --json kosmo integrations:ashby ashby_list_openings '{}' --json ashby.ashby_create_opening
Create an opening.
write - Parameters
- none
kosmo integrations:call ashby.ashby_create_opening '{}' --json kosmo integrations:ashby ashby_create_opening '{}' --json ashby.ashby_list_departments
List departments/teams.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_departments '{}' --json kosmo integrations:ashby ashby_list_departments '{}' --json ashby.ashby_list_locations
List locations.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_locations '{}' --json kosmo integrations:ashby ashby_list_locations '{}' --json ashby.ashby_list_sources
List sources.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_sources '{}' --json kosmo integrations:ashby ashby_list_sources '{}' --json ashby.ashby_list_interviews
List scheduled interviews in Ashby. Returns interview details with date, time, interviewers, and associated application. Filter by application to see interviews for a specific candidate.
read - Parameters
- limit, offset, application_id
kosmo integrations:call ashby.ashby_list_interviews '{"limit":1,"offset":1,"application_id":"example_application_id"}' --json kosmo integrations:ashby ashby_list_interviews '{"limit":1,"offset":1,"application_id":"example_application_id"}' --json ashby.ashby_get_interview
Get detailed information about a specific interview in Ashby, including scheduled time, interviewers, feedback, and scorecards.
read - Parameters
- id
kosmo integrations:call ashby.ashby_get_interview '{"id":"example_id"}' --json kosmo integrations:ashby ashby_get_interview '{"id":"example_id"}' --json ashby.ashby_list_interview_plans
List interview plans.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_interview_plans '{}' --json kosmo integrations:ashby ashby_list_interview_plans '{}' --json ashby.ashby_list_interview_schedules
List interview schedules.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_interview_schedules '{}' --json kosmo integrations:ashby ashby_list_interview_schedules '{}' --json ashby.ashby_update_interview_schedule
Update an interview schedule.
write - Parameters
- none
kosmo integrations:call ashby.ashby_update_interview_schedule '{}' --json kosmo integrations:ashby ashby_update_interview_schedule '{}' --json ashby.ashby_list_interview_events
List interview events.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_interview_events '{}' --json kosmo integrations:ashby ashby_list_interview_events '{}' --json ashby.ashby_list_offers
List offers.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_offers '{}' --json kosmo integrations:ashby ashby_list_offers '{}' --json ashby.ashby_get_offer
Get an offer.
read - Parameters
- none
kosmo integrations:call ashby.ashby_get_offer '{}' --json kosmo integrations:ashby ashby_get_offer '{}' --json ashby.ashby_create_offer
Create an offer.
write - Parameters
- none
kosmo integrations:call ashby.ashby_create_offer '{}' --json kosmo integrations:ashby ashby_create_offer '{}' --json ashby.ashby_update_offer
Update an offer.
write - Parameters
- none
kosmo integrations:call ashby.ashby_update_offer '{}' --json kosmo integrations:ashby ashby_update_offer '{}' --json ashby.ashby_approve_offer
Approve an offer.
write - Parameters
- none
kosmo integrations:call ashby.ashby_approve_offer '{}' --json kosmo integrations:ashby ashby_approve_offer '{}' --json ashby.ashby_get_file
Retrieve a file URL.
read - Parameters
- none
kosmo integrations:call ashby.ashby_get_file '{}' --json kosmo integrations:ashby ashby_get_file '{}' --json ashby.ashby_set_custom_field_value
Set a custom field value.
write - Parameters
- none
kosmo integrations:call ashby.ashby_set_custom_field_value '{}' --json kosmo integrations:ashby ashby_set_custom_field_value '{}' --json ashby.ashby_list_webhooks
List webhook settings.
read - Parameters
- none
kosmo integrations:call ashby.ashby_list_webhooks '{}' --json kosmo integrations:ashby ashby_list_webhooks '{}' --json ashby.ashby_get_webhook
Get a webhook setting.
read - Parameters
- none
kosmo integrations:call ashby.ashby_get_webhook '{}' --json kosmo integrations:ashby ashby_get_webhook '{}' --json ashby.ashby_create_webhook
Create a webhook setting.
write - Parameters
- none
kosmo integrations:call ashby.ashby_create_webhook '{}' --json kosmo integrations:ashby ashby_create_webhook '{}' --json ashby.ashby_update_assessment
Update assessment status/results.
write - Parameters
- none
kosmo integrations:call ashby.ashby_update_assessment '{}' --json kosmo integrations:ashby ashby_update_assessment '{}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
ashby.ashby_api_post 0 parameters
kosmo integrations:schema ashby.ashby_api_post --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_get_current_user 0 parameters
kosmo integrations:schema ashby.ashby_get_current_user --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_users 0 parameters
kosmo integrations:schema ashby.ashby_list_users --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_candidates 4 parameters
kosmo integrations:schema ashby.ashby_list_candidates --json | Parameter | Type | Required | Description |
|---|---|---|---|
createdAfter | integer | no | Return candidates created after this Unix epoch timestamp in milliseconds. |
cursor | string | no | Pagination cursor. |
syncToken | string | no | Incremental sync token. |
limit | integer | no | Maximum number of candidates to return (max/default 100). |
ashby.ashby_search_candidates 0 parameters
kosmo integrations:schema ashby.ashby_search_candidates --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_get_candidate 0 parameters
kosmo integrations:schema ashby.ashby_get_candidate --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_create_candidate 0 parameters
kosmo integrations:schema ashby.ashby_create_candidate --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_update_candidate 0 parameters
kosmo integrations:schema ashby.ashby_update_candidate --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_create_note 3 parameters
kosmo integrations:schema ashby.ashby_create_note --json | Parameter | Type | Required | Description |
|---|---|---|---|
candidateId | string | yes | The candidate UUID. |
content | string | yes | The note content (supports plain text). |
contentType | string | no | Content type, such as text/plain or text/html. |
ashby.ashby_list_candidate_notes 0 parameters
kosmo integrations:schema ashby.ashby_list_candidate_notes --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_applications 4 parameters
kosmo integrations:schema ashby.ashby_list_applications --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of applications to return (default: 100). |
offset | integer | no | Number of results to skip for pagination. |
job_id | string | no | Filter applications by job ID. |
status | string | no | Filter by application status (e.g., "hired", "rejected", "active"). |
ashby.ashby_get_application 1 parameters
kosmo integrations:schema ashby.ashby_get_application --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The application ID. |
ashby.ashby_create_application 0 parameters
kosmo integrations:schema ashby.ashby_create_application --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_update_application 0 parameters
kosmo integrations:schema ashby.ashby_update_application --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_criteria_evaluations 0 parameters
kosmo integrations:schema ashby.ashby_list_criteria_evaluations --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_jobs 3 parameters
kosmo integrations:schema ashby.ashby_list_jobs --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of jobs to return (default: 100). |
offset | integer | no | Number of results to skip for pagination. |
status | string | no | Filter by job status (e.g., "open", "closed", "draft"). |
ashby.ashby_search_jobs 0 parameters
kosmo integrations:schema ashby.ashby_search_jobs --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_get_job 1 parameters
kosmo integrations:schema ashby.ashby_get_job --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The job ID. |
ashby.ashby_create_job 0 parameters
kosmo integrations:schema ashby.ashby_create_job --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_update_job 0 parameters
kosmo integrations:schema ashby.ashby_update_job --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_job_postings 0 parameters
kosmo integrations:schema ashby.ashby_list_job_postings --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_get_job_posting 0 parameters
kosmo integrations:schema ashby.ashby_get_job_posting --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_openings 0 parameters
kosmo integrations:schema ashby.ashby_list_openings --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_create_opening 0 parameters
kosmo integrations:schema ashby.ashby_create_opening --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_departments 0 parameters
kosmo integrations:schema ashby.ashby_list_departments --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_locations 0 parameters
kosmo integrations:schema ashby.ashby_list_locations --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_sources 0 parameters
kosmo integrations:schema ashby.ashby_list_sources --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_interviews 3 parameters
kosmo integrations:schema ashby.ashby_list_interviews --json | Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of interviews to return (default: 100). |
offset | integer | no | Number of results to skip for pagination. |
application_id | string | no | Filter interviews by application ID. |
ashby.ashby_get_interview 1 parameters
kosmo integrations:schema ashby.ashby_get_interview --json | Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The interview ID. |
ashby.ashby_list_interview_plans 0 parameters
kosmo integrations:schema ashby.ashby_list_interview_plans --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_interview_schedules 0 parameters
kosmo integrations:schema ashby.ashby_list_interview_schedules --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_update_interview_schedule 0 parameters
kosmo integrations:schema ashby.ashby_update_interview_schedule --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_interview_events 0 parameters
kosmo integrations:schema ashby.ashby_list_interview_events --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_offers 0 parameters
kosmo integrations:schema ashby.ashby_list_offers --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_get_offer 0 parameters
kosmo integrations:schema ashby.ashby_get_offer --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_create_offer 0 parameters
kosmo integrations:schema ashby.ashby_create_offer --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_update_offer 0 parameters
kosmo integrations:schema ashby.ashby_update_offer --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_approve_offer 0 parameters
kosmo integrations:schema ashby.ashby_approve_offer --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_get_file 0 parameters
kosmo integrations:schema ashby.ashby_get_file --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_set_custom_field_value 0 parameters
kosmo integrations:schema ashby.ashby_set_custom_field_value --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_list_webhooks 0 parameters
kosmo integrations:schema ashby.ashby_list_webhooks --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_get_webhook 0 parameters
kosmo integrations:schema ashby.ashby_get_webhook --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_create_webhook 0 parameters
kosmo integrations:schema ashby.ashby_create_webhook --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
ashby.ashby_update_assessment 0 parameters
kosmo integrations:schema ashby.ashby_update_assessment --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
Permissions
Headless calls still follow the integration read/write permission policy. Configure read/write defaults with
integrations:configure. Add --force only for trusted automation that should bypass that policy.