Skip to main content

​
Prompts

​
List Prompts

Returns a list of your prompts. The prompts are returned sorted by creation date, with the most recent prompts appearing first 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.prompts.list(limit=10)

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.prompts.list({});

  console.log(result);
}

run();

​
Create a Prompt

Create a prompt 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.prompts.create(request={
        "display_name": "Raymundo83",
        "prompt": {
            "messages": [
                {
                    "role": "system",
                    "content": "You are a helpful assistant",
                },
                {
                    "role": "user",
                    "content": "What is the weather today?",
                },
            ],
            "model": "openai/gpt-4o",
            "max_tokens": 1000,
            "temperature": 0.7,
        },
        "path": "Default",
    })

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.prompts.create({
    displayName: "Raymundo83",
    prompt: {
      messages: [
        {
          role: "system",
          content: "You are a helpful assistant",
        },
        {
          role: "user",
          content: "What is the weather today?",
        },
      ],
      model: "openai/gpt-4o",
      maxTokens: 1000,
      temperature: 0.7,
    },
    path: "Default",
  });

  console.log(result);
}

run();

​
Retrieve a Prompt

Retrieves a prompt object 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.prompts.retrieve(id="<id>")

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.prompts.retrieve({
    id: "<id>",
  });

  console.log(result);
}

run();

​
Update a Prompt

Update a prompt 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.prompts.update(id="<id>", prompt={
        "messages": [
            {
                "role": "system",
                "content": "You are a helpful assistant",
            },
            {
                "role": "user",
                "content": "Hello!",
            },
        ],
        "model": "anthropic/claude-3-5-sonnet-20241022",
        "temperature": 0.5,
    }, path="Default")

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.prompts.update({
    id: "<id>",
    requestBody: {
      prompt: {
        messages: [
          {
            role: "system",
            content: "You are a helpful assistant",
          },
          {
            role: "user",
            content: "Hello!",
          },
        ],
        model: "anthropic/claude-3-5-sonnet-20241022",
        temperature: 0.5,
      },
      path: "Default",
    },
  });

  console.log(result);
}

run();

​
Delete a Prompt

Delete a prompt 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    orq.prompts.delete(id="<id>")

    # Use the SDK ...


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  await orq.prompts.delete({
    id: "<id>",
  });

}

run();

​
List Versions

Returns a list of your prompt versions. The prompt versions are returned sorted by creation date, with the most recent prompt versions appearing first 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.prompts.list_versions(prompt_id="<id>", limit=10)

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.prompts.listVersions({
    promptId: "<id>",
  });

  console.log(result);
}

run();

​
Get Version

Retrieves a specific version of a prompt by its ID and version ID. 
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.prompts.get_version(prompt_id="<id>", version_id="<id>")

    # Handle response
    print(res)


import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.prompts.getVersion({
    promptId: "<id>",
    versionId: "<id>",
  });

  console.log(result);
}

run();