Skip to main content
GET
/
service
/
v2
/
file-search
/
{job_id}
Get File Search Job Status
curl --request GET \
  --url https://oathnet.org/api/service/v2/file-search/{job_id} \
  --header 'x-api-key: <api-key>'
{
  "job_id": "<string>",
  "status": "queued",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "progress": {
    "logs_total": 123,
    "logs_completed": 123,
    "files_total": 123,
    "files_scanned": 123,
    "percent": 123,
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "summary": {
    "files_total": 123,
    "files_scanned": 123,
    "files_matched": 123,
    "matches": 123,
    "duration_ms": 123,
    "bytes_scanned": 123,
    "timeouts": 123,
    "budget_exceeded": true,
    "truncated": true
  },
  "matches": [
    {
      "log_id": "<string>",
      "file_id": "<string>",
      "file_name": "<string>",
      "relative_path": "<string>",
      "size_bytes": 123,
      "match_text": "<string>",
      "line_number": 123,
      "column_range": {
        "start": 123,
        "end": 123
      },
      "snippet": {
        "pre": [
          "<string>"
        ],
        "line": "<string>",
        "post": [
          "<string>"
        ],
        "truncated": true
      },
      "extra": {}
    }
  ],
  "limits": {
    "max_matches": 123,
    "max_file_size_bytes": 123,
    "byte_budget_bytes": 123,
    "max_context_lines": 123,
    "job_ttl_seconds": 123,
    "max_log_ids": 123,
    "max_expression_length": 123
  },
  "next_poll_after_ms": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.oathnet.org/llms.txt

Use this file to discover all available pages before exploring further.

Poll this endpoint after creating a file-search job.
The payload is a raw job snapshot. Check the status field rather than expecting a top-level success flag.

Authorizations

​
x-api-key
string
header
required

API key for authentication (lowercase header name)

Path Parameters

​
job_id
string
required

Response

Raw file-search job snapshot

​
job_id
string
​
status
enum<string>
Available options:
queued,
running,
completed,
canceled
​
created_at
string<date-time>
​
started_at
string<date-time>
​
completed_at
string<date-time>
​
expires_at
string<date-time>
​
progress
object
​
summary
object
​
matches
object[]
​
limits
object
​
next_poll_after_ms
integer