GET
/
data
/
generate
import PiClient from 'withpi';

const client = new PiClient({
  apiKey: process.env['WITHPI_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const dataGenerationStatuses = await client.data.generate.list();

  console.log(dataGenerationStatuses);
}

main();
[
  {
    "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

Query Parameters

​
state
enum<string> | null

Filter jobs by state

Available options:
QUEUED,
RUNNING,
DONE,
ERROR,
CANCELLED

Response

200
application/json
Successful Response
​
detailed_status
string[]
required

Detailed status of the job

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

The job id

Example:

"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.

Example:
[
  "The quick brown fox jumped over the lazy dog",
  "The lazy dog was jumped over by the quick brown fox"
]
Stream MessagesStart Job