ORorq-ai
Prompts

Update a prompt

Changed on

Update a prompt by ID with the provided fields.

patch/v2/prompts/{id}

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/prompts/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Unique identifier of the prompt

Request body

ownerstring
domain_idstring uuid
createdstring
updatedstring
created_by_idstring uuid nullable
updated_by_idstring uuid nullable
display_namestring

The prompt’s name, meant to be displayable in the UI.

descriptionstring nullable

The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose

pathstring

Entity storage path.

With workspace-level API keys, use the format project/folder/subfolder/.... The first element must be the display name of an existing project, followed by nested folders (auto-created as needed). Example: Default Project/agents.

With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: agents. For backward compatibility, a leading project name is ignored when it matches the scoped project.

Example request

{
  "prompt": {
    "model": "anthropic/claude-3-5-sonnet-20241022",
    "messages": [
      {
        "role": "system",
        "content": "You are a helpful assistant"
      },
      {
        "role": "user",
        "content": "Hello!"
      }
    ],
    "temperature": 0.5
  },
  "path": "Default Project"
}

Response

Prompt updated.

_idstring required
type'prompt' required
ownerstring required
domain_idstring uuid required
createdstring required
updatedstring required
created_by_idstring uuid nullable
updated_by_idstring uuid nullable
display_namestring required

The prompt’s name, meant to be displayable in the UI.

descriptionstring nullable

The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose

Example response

{
  "prompt_config": {
    "messages": [
      {
        "content": [
          {
            "image_url": {
              "url": "https://picsum.photos/id/1/200/300"
            }
          }
        ]
      }
    ]
  },
  "prompt": {
    "fallbacks": [
      {
        "model": "openai/gpt-5.4-mini"
      }
    ],
    "retry": {
      "count": 3,
      "on_codes": [
        429,
        500,
        502,
        503,
        504
      ]
    },
    "cache": {
      "ttl": 3600
    },
    "load_balancer": {
      "type": "weight_based",
      "models": [
        {
          "model": "openai/gpt-4o",
          "weight": 0.7
        },
        {
          "model": "anthropic/claude-3-5-sonnet",
          "weight": 0.3
        }
      ]
    },
    "timeout": {
      "call_timeout": 30000
    },
    "model": "openai/gpt-5.6-sol"
  }
}

Changes

  • 928a71e92252Revision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new munito enum value to the / response property for the response status

    • warning

      added the new particle enum value to the / response property for the response status

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added between_tools discriminator mapping keys to the / request property

    • info

      added to the / request property oneOf list

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added between_tools discriminator mapping keys to the / response property for the response status

  • 33d63277cd4eRevision changes
    • breaking

      removed from the / request property oneOf list

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      removed between_tools discriminator mapping keys from the / request property

    • info

      removed between_tools discriminator mapping keys from the / response property for the response status

    • info

      removed the munito enum value from the / response property for the response status

    • info

      removed the particle enum value from the / response property for the response status

    • info

      removed from the / response property oneOf list for the response status