GET
/
data
/
generate
/
{job_id}
JavaScript
import PiClient from 'withpi';

const client = new PiClient({
  apiKey: 'My API Key',
});

const dataGenerationStatus = await client.data.generate.retrieve('job_id');

console.log(dataGenerationStatus.job_id);
{
  "data": [
    "The quick brown fox jumped over the lazy dog",
    "The lazy dog was jumped over by the quick brown fox"
  ],
  "detailed_status": [
    "Downloading model",
    "Tuning prompt"
  ],
  "job_id": "1234abcd",
  "state": "RUNNING"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
job_id
string
required

Response

Successful Response

DataGenerationStatus is the result of a data generation job.

​
detailed_status
string[]
required

Detailed status of the job

Examples:
["Downloading model", "Tuning prompt"]
​
job_id
string
required

The job id

Examples:

"1234abcd"

​
state
enum<string>
required

Current state of the job

Available options:
QUEUED,
RUNNING,
DONE,
ERROR,
CANCELLED
​
data
string[] | null

The generated data. Can be present even if the state is not done/error as it is streamed.

Examples:
[
  "The quick brown fox jumped over the lazy dog",
  "The lazy dog was jumped over by the quick brown fox"
]