Skip to main content
GET
/
v4
/
knowledge-bases
/
{knowledge_base_id}
/
async-jobs
Python
import os
from scale_gp import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
page = client.knowledge_bases.async_jobs.list(
    knowledge_base_id="knowledge_base_id",
)
page = page.items[0]
print(page.id)
package main

import (
"context"
"fmt"

"github.com/stainless-sdks/sgp-go"
"github.com/stainless-sdks/sgp-go/option"
)

func main() {
client := sgp.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.KnowledgeBases.AsyncJobs.List(
context.TODO(),
"knowledge_base_id",
sgp.KnowledgeBaseAsyncJobListParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
curl --request GET \
--url https://api.egp.scale.com/v4/knowledge-bases/{knowledge_base_id}/async-jobs \
--header 'x-api-key: <api-key>'
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.egp.scale.com/v4/knowledge-bases/{knowledge_base_id}/async-jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.egp.scale.com/v4/knowledge-bases/{knowledge_base_id}/async-jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
HttpResponse<String> response = Unirest.get("https://api.egp.scale.com/v4/knowledge-bases/{knowledge_base_id}/async-jobs")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.egp.scale.com/v4/knowledge-bases/{knowledge_base_id}/async-jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "status": "<string>",
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "account_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "parent_job_id": "<string>",
    "status_reason": "<string>",
    "progress": {},
    "job_metadata": {},
    "idempotency_key": "<string>",
    "created_by_user_id": "<string>"
  }
]
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Path Parameters

knowledge_base_id
string
required

Query Parameters

status
default:Active

Optional search by status type

Available options:
Active,
All
page
integer
default:1

Page number for pagination to be returned by the given endpoint. Starts at page 1

Required range: x >= 1
limit
integer
default:100

Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.

Required range: 1 <= x <= 10000

Response

Successful Response

job_type
enum<string>
required
Available options:
evaluation-auto-eval,
evaluation-test-cases-result-gen,
evaluation-metrics-gen,
evaluation-builder,
evaluation-dataset-generation,
knowledge_base_upload,
application-variant-report-generation,
application-interaction-evaluation,
deploy-inference-model,
update-inference-model,
evaluation-task-execution,
evaluation-task-runner,
parse-document
status
string
required
id
string
required

The unique identifier of the entity.

created_at
string<date-time>
required

The date and time when the entity was created in ISO format.

account_id
string
required

The ID of the account that owns the given entity.

updated_at
string<date-time>
required

The date and time when the entity was last updated in ISO format.

parent_job_id
string
status_reason
string
progress
Progress · object
job_metadata
Job Metadata · object
idempotency_key
string
created_by_user_id
string

The user who originally created the entity.

created_by_identity_type
enum<string>

The type of identity that created the entity.

Available options:
user,
service_account