> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a project

> Updates the specified project by setting the values of the parameters passed.



## OpenAPI

````yaml patch /v2/projects/{project_id}
openapi: 3.1.0
info:
  title: orq.ai API
  version: '2.0'
  description: orq.ai API documentation
servers:
  - url: https://api.orq.ai
security:
  - ApiKey: []
tags:
  - description: List models available through the AI Router.
    name: Models
  - name: Guardrail Rules
  - name: Policies
  - name: Routing Rules
  - name: API keys
    description: >-
      API keys authenticate programmatic access to the workspace. The unified
      key model exposes opaque tokens, per-domain access grants, and budget /
      rate-limit constraints (see ADR 0001 and ADR 0002).
  - name: Budgets
    description: >-
      Budgets govern spend, token usage, and request rate across six scopes:
      workspace, project, identity, api-key, provider, and model. A budget is
      hierarchical and defense-in-depth — every applicable budget is a hard
      gate, and the most restrictive one wins per dimension (see ADR 0007).
  - name: Documentation
    description: >-
      Search the orq.ai documentation. Proxies the workspace's query to the
      hosted docs search index.
  - name: Files
    description: File upload and retrieval operations.
  - name: Identities
    description: >-
      Identities represent end users from your system for usage and engagement
      tracking.
  - name: Projects
    description: Projects organize resources within a workspace
  - name: Skills
    description: >-
      Skills are modular instructions you can use to codify processes and
      conventions
  - name: Responses
  - description: >-
      Run agents on a cadence — cron, interval, or one-off. Minimum firing
      interval is 1 hour.
    name: Agent Schedules
  - name: Embeddings
  - name: Reporting
    description: >-
      GenAI reporting API over canonical analytics rollups. Accepts a metric
      name, time range, grain, group-by, and filters; returns a typed time
      series and optional totals.
externalDocs:
  url: https://docs.orq.ai
  description: orq.ai Documentation
paths:
  /v2/projects/{project_id}:
    patch:
      tags:
        - Projects
      summary: Update a project
      description: >-
        Updates the specified project by setting the values of the parameters
        passed.
      operationId: ProjectUpdate
      parameters:
        - name: project_id
          in: path
          description: Project ID to update.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProjectRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateProjectResponse'
      x-code-samples:
        - lang: curl
          label: Core - Update project
          source: |
            curl --request PATCH \
              --url 'https://api.orq.ai/v2/projects/proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \
              --header 'Authorization: Bearer $ORQ_API_KEY' \
              --header 'Content-Type: application/json' \
              --data '{
                "name": "Customer Success Production",
                "description": "Production support and retention automations",
                "teams": ["team_support"]
              }'
        - lang: python
          label: Python - Update project
          source: |
            import os
            from orq_ai_sdk import Orq

            client = Orq(api_key=os.environ["ORQ_API_KEY"])

            result = client.projects.update(
                project_id="proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V",
                name="Customer Success Production",
                description="Production support and retention automations",
                teams=["team_support"],
            )

            print(result.project.name)
        - lang: typescript
          label: Node.js - Update project
          source: |
            import { Orq } from '@orq-ai/node';

            const client = new Orq({
              apiKey: process.env.ORQ_API_KEY,
            });

            const result = await client.projects.update({
              projectId: 'proj_01HZXW2K7Y8Q9M0N1P2R3S4T5V',
              name: 'Customer Success Production',
              description: 'Production support and retention automations',
              teams: ['team_support'],
            });

            console.log(result.project.name);
components:
  schemas:
    UpdateProjectRequest:
      required: []
      type: object
      properties:
        name:
          type: string
          description: New project name. Omit to keep the current name.
        teams:
          type: array
          items:
            type: string
          description: |-
            Replacement list of team identifiers associated with the project.
             Leave empty to remove all team associations.
        description:
          type: string
          description: New project description. Omit to keep the current description.
    UpdateProjectResponse:
      required:
        - project
      type: object
      properties:
        project:
          allOf:
            - $ref: '#/components/schemas/Project'
          description: Updated project.
    Project:
      required:
        - project_id
        - name
        - key
        - is_archived
        - is_default
        - teams
        - created_at
        - updated_at
      type: object
      properties:
        project_id:
          type: string
          description: |-
            Unique project identifier assigned by ORQ. Use this value in
             retrieve, update, and delete requests.
        name:
          type: string
          description: Human-readable project name.
        key:
          type: string
          description: |-
            Stable project key generated from the name and used by internal
             workspace navigation.
        is_archived:
          type: boolean
          description: |-
            Whether the project is archived and hidden from normal active
             project lists.
        is_default:
          type: boolean
          description: Whether this is the workspace default project.
        teams:
          type: array
          items:
            type: string
          description: |-
            Team identifiers associated with the project for access and
             organization.
        created_at:
          type: string
          description: Time when the project was created.
          format: date-time
        updated_at:
          type: string
          description: Time when the project was last updated.
          format: date-time
        created_by_id:
          type: string
          description: User ID that created the project.
        updated_by_id:
          type: string
          description: User ID that last updated the project.
        description:
          type: string
          description: Optional human-readable description of the project.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT

````