KosmoKrator

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, configure, and verify
# 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.

KeyEnv varTypeRequiredLabel
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.

Generic CLI call
kosmo integrations:call ashby.ashby_api_post '{}' --json
Provider shortcut
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.

Discovery commands
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 write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_api_post '{}' --json
Shortcut
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 read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_get_current_user '{}' --json
Shortcut
kosmo integrations:ashby ashby_get_current_user '{}' --json

ashby.ashby_list_users

List Ashby users.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_users '{}' --json
Shortcut
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 read
Parameters
createdAfter, cursor, syncToken, limit
Generic call
kosmo integrations:call ashby.ashby_list_candidates '{"createdAfter":1,"cursor":"example_cursor","syncToken":"example_syncToken","limit":1}' --json
Shortcut
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 read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_search_candidates '{}' --json
Shortcut
kosmo integrations:ashby ashby_search_candidates '{}' --json

ashby.ashby_get_candidate

Get a single candidate.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_get_candidate '{}' --json
Shortcut
kosmo integrations:ashby ashby_get_candidate '{}' --json

ashby.ashby_create_candidate

Create a candidate.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_create_candidate '{}' --json
Shortcut
kosmo integrations:ashby ashby_create_candidate '{}' --json

ashby.ashby_update_candidate

Update a candidate.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_update_candidate '{}' --json
Shortcut
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 write
Parameters
candidateId, content, contentType
Generic call
kosmo integrations:call ashby.ashby_create_note '{"candidateId":"example_candidateId","content":"example_content","contentType":"example_contentType"}' --json
Shortcut
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 read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_candidate_notes '{}' --json
Shortcut
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 read
Parameters
limit, offset, job_id, status
Generic call
kosmo integrations:call ashby.ashby_list_applications '{"limit":1,"offset":1,"job_id":"example_job_id","status":"example_status"}' --json
Shortcut
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 read
Parameters
id
Generic call
kosmo integrations:call ashby.ashby_get_application '{"id":"example_id"}' --json
Shortcut
kosmo integrations:ashby ashby_get_application '{"id":"example_id"}' --json

ashby.ashby_create_application

Create an application for a candidate and job.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_create_application '{}' --json
Shortcut
kosmo integrations:ashby ashby_create_application '{}' --json

ashby.ashby_update_application

Update an application.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_update_application '{}' --json
Shortcut
kosmo integrations:ashby ashby_update_application '{}' --json

ashby.ashby_list_criteria_evaluations

List AI criteria evaluations for an application.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_criteria_evaluations '{}' --json
Shortcut
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 read
Parameters
limit, offset, status
Generic call
kosmo integrations:call ashby.ashby_list_jobs '{"limit":1,"offset":1,"status":"example_status"}' --json
Shortcut
kosmo integrations:ashby ashby_list_jobs '{"limit":1,"offset":1,"status":"example_status"}' --json

ashby.ashby_search_jobs

Search jobs.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_search_jobs '{}' --json
Shortcut
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 read
Parameters
id
Generic call
kosmo integrations:call ashby.ashby_get_job '{"id":"example_id"}' --json
Shortcut
kosmo integrations:ashby ashby_get_job '{"id":"example_id"}' --json

ashby.ashby_create_job

Create a job.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_create_job '{}' --json
Shortcut
kosmo integrations:ashby ashby_create_job '{}' --json

ashby.ashby_update_job

Update a job.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_update_job '{}' --json
Shortcut
kosmo integrations:ashby ashby_update_job '{}' --json

ashby.ashby_list_job_postings

List job postings.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_job_postings '{}' --json
Shortcut
kosmo integrations:ashby ashby_list_job_postings '{}' --json

ashby.ashby_get_job_posting

Get a job posting.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_get_job_posting '{}' --json
Shortcut
kosmo integrations:ashby ashby_get_job_posting '{}' --json

ashby.ashby_list_openings

List openings.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_openings '{}' --json
Shortcut
kosmo integrations:ashby ashby_list_openings '{}' --json

ashby.ashby_create_opening

Create an opening.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_create_opening '{}' --json
Shortcut
kosmo integrations:ashby ashby_create_opening '{}' --json

ashby.ashby_list_departments

List departments/teams.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_departments '{}' --json
Shortcut
kosmo integrations:ashby ashby_list_departments '{}' --json

ashby.ashby_list_locations

List locations.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_locations '{}' --json
Shortcut
kosmo integrations:ashby ashby_list_locations '{}' --json

ashby.ashby_list_sources

List sources.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_sources '{}' --json
Shortcut
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 read
Parameters
limit, offset, application_id
Generic call
kosmo integrations:call ashby.ashby_list_interviews '{"limit":1,"offset":1,"application_id":"example_application_id"}' --json
Shortcut
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 read
Parameters
id
Generic call
kosmo integrations:call ashby.ashby_get_interview '{"id":"example_id"}' --json
Shortcut
kosmo integrations:ashby ashby_get_interview '{"id":"example_id"}' --json

ashby.ashby_list_interview_plans

List interview plans.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_interview_plans '{}' --json
Shortcut
kosmo integrations:ashby ashby_list_interview_plans '{}' --json

ashby.ashby_list_interview_schedules

List interview schedules.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_interview_schedules '{}' --json
Shortcut
kosmo integrations:ashby ashby_list_interview_schedules '{}' --json

ashby.ashby_update_interview_schedule

Update an interview schedule.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_update_interview_schedule '{}' --json
Shortcut
kosmo integrations:ashby ashby_update_interview_schedule '{}' --json

ashby.ashby_list_interview_events

List interview events.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_interview_events '{}' --json
Shortcut
kosmo integrations:ashby ashby_list_interview_events '{}' --json

ashby.ashby_list_offers

List offers.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_offers '{}' --json
Shortcut
kosmo integrations:ashby ashby_list_offers '{}' --json

ashby.ashby_get_offer

Get an offer.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_get_offer '{}' --json
Shortcut
kosmo integrations:ashby ashby_get_offer '{}' --json

ashby.ashby_create_offer

Create an offer.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_create_offer '{}' --json
Shortcut
kosmo integrations:ashby ashby_create_offer '{}' --json

ashby.ashby_update_offer

Update an offer.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_update_offer '{}' --json
Shortcut
kosmo integrations:ashby ashby_update_offer '{}' --json

ashby.ashby_approve_offer

Approve an offer.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_approve_offer '{}' --json
Shortcut
kosmo integrations:ashby ashby_approve_offer '{}' --json

ashby.ashby_get_file

Retrieve a file URL.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_get_file '{}' --json
Shortcut
kosmo integrations:ashby ashby_get_file '{}' --json

ashby.ashby_set_custom_field_value

Set a custom field value.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_set_custom_field_value '{}' --json
Shortcut
kosmo integrations:ashby ashby_set_custom_field_value '{}' --json

ashby.ashby_list_webhooks

List webhook settings.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_list_webhooks '{}' --json
Shortcut
kosmo integrations:ashby ashby_list_webhooks '{}' --json

ashby.ashby_get_webhook

Get a webhook setting.

Read read
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_get_webhook '{}' --json
Shortcut
kosmo integrations:ashby ashby_get_webhook '{}' --json

ashby.ashby_create_webhook

Create a webhook setting.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_create_webhook '{}' --json
Shortcut
kosmo integrations:ashby ashby_create_webhook '{}' --json

ashby.ashby_update_assessment

Update assessment status/results.

Write write
Parameters
none
Generic call
kosmo integrations:call ashby.ashby_update_assessment '{}' --json
Shortcut
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
Schema command
kosmo integrations:schema ashby.ashby_api_post --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_get_current_user 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_get_current_user --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_users 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_users --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_candidates 4 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_candidates --json
ParameterTypeRequiredDescription
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
Schema command
kosmo integrations:schema ashby.ashby_search_candidates --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_get_candidate 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_get_candidate --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_create_candidate 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_create_candidate --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_update_candidate 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_update_candidate --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_create_note 3 parameters
Schema command
kosmo integrations:schema ashby.ashby_create_note --json
ParameterTypeRequiredDescription
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
Schema command
kosmo integrations:schema ashby.ashby_list_candidate_notes --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_applications 4 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_applications --json
ParameterTypeRequiredDescription
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
Schema command
kosmo integrations:schema ashby.ashby_get_application --json
ParameterTypeRequiredDescription
id string yes The application ID.
ashby.ashby_create_application 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_create_application --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_update_application 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_update_application --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_criteria_evaluations 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_criteria_evaluations --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_jobs 3 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_jobs --json
ParameterTypeRequiredDescription
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
Schema command
kosmo integrations:schema ashby.ashby_search_jobs --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_get_job 1 parameters
Schema command
kosmo integrations:schema ashby.ashby_get_job --json
ParameterTypeRequiredDescription
id string yes The job ID.
ashby.ashby_create_job 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_create_job --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_update_job 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_update_job --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_job_postings 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_job_postings --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_get_job_posting 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_get_job_posting --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_openings 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_openings --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_create_opening 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_create_opening --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_departments 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_departments --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_locations 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_locations --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_sources 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_sources --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_interviews 3 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_interviews --json
ParameterTypeRequiredDescription
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
Schema command
kosmo integrations:schema ashby.ashby_get_interview --json
ParameterTypeRequiredDescription
id string yes The interview ID.
ashby.ashby_list_interview_plans 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_interview_plans --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_interview_schedules 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_interview_schedules --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_update_interview_schedule 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_update_interview_schedule --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_interview_events 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_interview_events --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_offers 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_offers --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_get_offer 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_get_offer --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_create_offer 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_create_offer --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_update_offer 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_update_offer --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_approve_offer 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_approve_offer --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_get_file 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_get_file --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_set_custom_field_value 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_set_custom_field_value --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_list_webhooks 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_list_webhooks --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_get_webhook 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_get_webhook --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_create_webhook 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_create_webhook --json
ParameterTypeRequiredDescription
No parameters.
ashby.ashby_update_assessment 0 parameters
Schema command
kosmo integrations:schema ashby.ashby_update_assessment --json
ParameterTypeRequiredDescription
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.