Check knowledge jobs

curl --request POST \
  --url 'https://api-prod.usefini.com/v2/knowledge/public/jobs/status' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "jobIds": [
      "4cfcf2cc-7a06-4de2-b460-5b991fe6236a"
    ]
  }'

{
  "jobs": [
    {
      "id": "4cfcf2cc-7a06-4de2-b460-5b991fe6236a",
      "jobStatus": "COMPLETED",
      "createdAt": "2026-06-11T12:00:00.000Z",
      "startedAt": "2026-06-11T12:00:01.000Z",
      "completedAt": "2026-06-11T12:00:05.000Z",
      "hcArticleId": "7f5392e5-dc7d-4558-8860-cf3ea4b32f94"
    }
  ]
}

POST

knowledge

public

jobs

status

curl --request POST \
  --url 'https://api-prod.usefini.com/v2/knowledge/public/jobs/status' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "jobIds": [
      "4cfcf2cc-7a06-4de2-b460-5b991fe6236a"
    ]
  }'

{
  "jobs": [
    {
      "id": "4cfcf2cc-7a06-4de2-b460-5b991fe6236a",
      "jobStatus": "COMPLETED",
      "createdAt": "2026-06-11T12:00:00.000Z",
      "startedAt": "2026-06-11T12:00:01.000Z",
      "completedAt": "2026-06-11T12:00:05.000Z",
      "hcArticleId": "7f5392e5-dc7d-4558-8860-cf3ea4b32f94"
    }
  ]
}

Use this route to poll background jobs queued by Generate knowledge or Bulk generate knowledge.

Headers

string

required

Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs read scope.

string

required

application/json

Body parameters

array

required

Background job IDs to inspect.

Response

array

Status rows for the requested jobs.

Show job status object

string

Background job ID.

string

Current job status.

string

ISO 8601 creation timestamp, when present.

string

ISO 8601 start timestamp, when present.

string

ISO 8601 completion timestamp, when present.

string | null

Linked Article ID once the job finishes and creates or updates knowledge.

curl --request POST \
  --url 'https://api-prod.usefini.com/v2/knowledge/public/jobs/status' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "jobIds": [
      "4cfcf2cc-7a06-4de2-b460-5b991fe6236a"
    ]
  }'

{
  "jobs": [
    {
      "id": "4cfcf2cc-7a06-4de2-b460-5b991fe6236a",
      "jobStatus": "COMPLETED",
      "createdAt": "2026-06-11T12:00:00.000Z",
      "startedAt": "2026-06-11T12:00:01.000Z",
      "completedAt": "2026-06-11T12:00:05.000Z",
      "hcArticleId": "7f5392e5-dc7d-4558-8860-cf3ea4b32f94"
    }
  ]
}

Errors

400 Bad Request

The request body is malformed or jobIds is missing or empty.

401 Unauthorized

The API key is missing, malformed, revoked, or invalid.

403 Forbidden

The API key does not include the read scope.

404 Not Found

One or more job IDs do not exist, are inaccessible from this workspace, or are not knowledge-generation jobs.

500 Internal Server Error

Fini failed while reading job status. Retry once, then narrow the request to isolate the failing job ID.

⌘I

​Headers

​Body parameters

​Response

​Errors

Headers

Body parameters

Response

Errors