New: Kith open-sources its ATS.Read why
Skip to Content
Objects

Agent

An agent that works for a workspace: it reads a candidate or a job and acts on it, such as screening or research. Every workspace starts with Kith ATS's standard set.

type Agent {
  hire: AgentHire
  id: ID!
  isEnabled: Boolean!
  kind: AgentKind
  name: String!
  role: String!
}

Fields

Agent.hire · AgentHire object

The terms the workspace hired this agent on. Null for the agents every workspace gets, which are not billed.

Agent.id · ID! non-null scalar

The agent's id.

Agent.isEnabled · Boolean! non-null scalar

False when the agent has been switched off or its hire ended. It is then not offered and runAgent refuses it.

Agent.kind · AgentKind enum

Which of Kith ATS's standard agents this is. Null for an agent the workspace hired with its own instructions.

Agent.name · String! non-null scalar

The agent's name, as shown where a person picks one.

Agent.role · String! non-null scalar

What the agent does, as a short label.

Returned By

agent query

Member Of

AddDefaultAgentsPayload object · AgentBillingPeriod object · AgentEdge object · AgentRun object · HireAgentPayload object · TerminateAgentPayload object

On this page

FieldsAgent.hire · AgentHire objectAgent.id · ID! non-null scalarAgent.isEnabled · Boolean! non-null scalarAgent.kind · AgentKind enumAgent.name · String! non-null scalarAgent.role · String! non-null scalarReturned ByMember Of