Retrieve a method

GET

/v1/methods/{method}

const url = 'https://api.pensievelabs.co/v1/methods/fine-tuning';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.pensievelabs.co/v1/methods/fine-tuning \
  --header 'Authorization: Bearer <token>'

A removed method answers not_found unless you pass version; every version it had stays readable.

Authorizations

bearer

Parameters

Path Parameters

method

required

A post-training method’s slug, such as fine-tuning. See List methods for what your workspace has.

string

<= 64 characters /^[a-z0-9]+(-[a-z0-9]+)*$/

Example

fine-tuning

Query Parameters

version

integer

>= 1

An earlier version of the file, such as the one an experiment ran. Default: the latest. Needed for a removed method.

Responses

200

The method.

application/json

A post-training method, written as a plain markdown file. It starts with a # title and a paragraph saying what the method does and when to try it; the rest is up to its author. Pensieve’s own files have Needs, Steps, Settings (what an experiment can change) and Checks. Agents read the file to design experiments with the method and follow it as written.

object

required

A post-training method’s slug, such as fine-tuning. See List methods for what your workspace has.

string

<= 64 characters /^[a-z0-9]+(-[a-z0-9]+)*$/

object

required

Allowed value: method

name

required

The file’s title.

string

description

required

The file’s first paragraph.

string

markdown

required

The whole file.

string

version

required

Goes up by one with every change. Each experiment records the version it ran.

integer

>= 1

built_in

required

Shipped by Pensieve. Built-in methods can’t be changed or removed.

boolean

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "id": "fine-tuning",
  "object": "method",
  "name": "Fine-tuning"
}

default

Something went wrong; error.type says what.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request authentication permission not_found conflict rate_limit not_available server

message

required

string

param

The request field the error is about.

string | null

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request"
  }
}