Get job details

GET

/jobs/{jobId}

curl --request GET \
  --url https://firma.company-gpt.com/companygpt/rag/api/jobs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• CompanyGPT instance

Get detailed information about a specific job, including its file when it can still be resolved

Authorizations

• BearerAuth

Parameters

Path Parameters

jobId

required

string format: uuid

Job UUID

Responses

200

Job details

Media typeapplication/json

Response for GET /jobs/{jobId} (handlers.JobDetailResponse)

object

job

required

Indexing job information (handlers.JobInfo)

object

id

required

Unique job identifier

string format: uuid

fileId

required

Associated file ID

string format: uuid

fileName

Name of the file being processed (list endpoint only)

string

nullable

collectionId

Associated collection ID (list endpoint only)

string format: uuid

nullable

collectionName

Associated collection name (list endpoint only)

string

nullable

type

required

Job action type (JSON key is “type”; the Go field is named Action)

string

Allowed values: index reindex delete rebuild_fts

status

required

Current job status

string

Allowed values: queued running completed failed cancelled

retryCount

required

Number of retries attempted

integer

maxRetries

required

Maximum allowed retries

integer

error

Error message if job failed

string

nullable

createdAt

required

ISO 8601 creation timestamp

string format: date-time

startedAt

ISO 8601 start timestamp

string format: date-time

nullable

completedAt

ISO 8601 completion timestamp

string format: date-time

nullable

queuePosition

1-based position in the global FIFO queue; present only for jobs currently in ‘queued’ status (list endpoint only)

integer

nullable

file

Present when the job’s file could still be resolved

object

id

required

Unique file identifier

string format: uuid

name

required

Original file name

string

blobPath

required

Path in blob storage

string

sizeBytes

File size in bytes

integer format: int64

nullable

contentType

MIME type

string

nullable

status

required

File processing status

string

Allowed values: pending indexed indexed_with_warning failed

collectionId

Associated collection ID

string format: uuid

nullable

collectionName

Associated collection name

string

nullable

createdAt

required

ISO 8601 creation timestamp

string format: date-time

updatedAt

required

ISO 8601 last update timestamp

string format: date-time

lastIndexedAt

ISO 8601 last indexing timestamp

string format: date-time

nullable

sourceMetadata

Source-specific metadata (ACL fields, SharePoint item info, etc.); omitted/empty for files with no metadata

object

key

additional properties

any

Example

{
  "job": {
    "type": "index",
    "status": "queued"
  },
  "file": {
    "status": "pending"
  }
}

400

Invalid job ID

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

401

Unauthorized

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

403

Access denied

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

404

Job not found

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}