Prompt oluştur

Workspace'inizde yeni bir prompt oluşturun

Workspace'inizde bir prompt oluşturur. API anahtarını oluşturan kullanıcı prompt sahibi olur ve onu Prompt Library'de yönetebilir.

Base URL

https://api.ajan.io/prompts/v1

Dedicated deployments Tüm isteklerde api.ajan.com'u /api/public ile değiştirin.

Required Scopes

Bu endpoint PROMPT_API kapsamını gerektirir.

Prompt'u workspace ile paylaşmak için sharePrompts izni gerekir. Klasör atamak için o klasöre yazma erişimi gerekir.

Parameters

Parameter	Type	Required	Description
`title`	string	Yes	Prompt başlığı. Minimum: 2 karakter. Maksimum: 100 karakter.
`prompt`	string	Yes	Prompt içeriği. Minimum: 2 karakter. Maksimum: 120000 karakter.
`promptFolderId`	string	No	Atanacak klasörün UUID'si. `sharedWithWorkspace` `true` iken ayarlanamaz.
`sharedWithWorkspace`	boolean	No	Prompt'u workspace ile paylaş. `promptFolderId` ayarlıyken `true` olamaz.

Example

javascript

const axios = require("axios");

async function createPrompt() {
  const response = await axios.post(
    "https://api.ajan.io/prompts/v1",
    {
      title: "Support Reply",
      prompt: "Write a concise customer reply. Include the next best action.",
      sharedWithWorkspace: true
    },
    {
      headers: {
        Authorization: "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
      }
    }
  );

  console.log("Created prompt:", response.data.prompt.id);
}

createPrompt();

Response Format

Success Response (201 Created)

typescript

{
  prompt: {
    id: string;
    title: string;
    prompt: string;
    createdBy: string | null;
    promptFolderId: string | null;
    sharedWithWorkspace: boolean;
    createdAt: string | null;
    updatedAt: string | null;
  };
}

Error Handling

Status Code	Description
400	Geçersiz istek gövdesi veya workspace paylaşımı ile klasör atamasının birlikte kullanılması
401	Geçersiz veya eksik API anahtarı
403	Eksik `PROMPT_API` kapsamı, paylaşım izni veya klasör yazma erişimi
404	Prompt klasörü bulunamadı
429	Rate limit aşıldı
500	Dahili sunucu hatası

ajan, API anahtarınızı korumak ve uygulamalarınızın güvenliğini sağlamak için tarayıcı kaynaklı istekleri bilinçli olarak engeller. Daha fazla bilgi için API Key Best Practices kılavuzuna bakın.

OpenAPI

openapi: 3.0.0
info:
  title: ajan API
  version: 3.0.0
servers:
  - url: https://api.ajan.io
    description: Production
security:
  - bearerAuth: []
paths:
  /prompts/v1:
    post:
      tags:
        - Prompts
      summary: Create a prompt
      description: Creates a prompt in your workspace.
      operationId: createPrompt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePromptRequest'
      responses:
        '201':
          description: Prompt created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptResponse'
        '400':
          description: Invalid request body
        '401':
          description: Invalid or missing API key
        '403':
          description: Missing required scope, share permission, or folder write access
        '404':
          description: Prompt folder not found
        '429':
          description: Rate limit exceeded
        '500':
          description: Internal server error
components:
  schemas:
    CreatePromptRequest:
      type: object
      required:
        - title
        - prompt
      additionalProperties: false
      properties:
        title:
          type: string
          minLength: 2
          maxLength: 100
          description: Prompt title.
        prompt:
          type: string
          minLength: 2
          maxLength: 120000
          description: Prompt content.
        promptFolderId:
          type: string
          format: uuid
          description: >-
            Folder UUID to assign. Cannot be set when sharedWithWorkspace is
            true.
        sharedWithWorkspace:
          type: boolean
          description: >-
            Share the prompt with the workspace. Cannot be true when
            promptFolderId is set.
    PromptResponse:
      type: object
      required:
        - prompt
      properties:
        prompt:
          $ref: '#/components/schemas/Prompt'
    Prompt:
      type: object
      required:
        - id
        - title
        - prompt
        - sharedWithWorkspace
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the prompt.
        title:
          type: string
          minLength: 2
          maxLength: 100
          description: Prompt title.
        prompt:
          type: string
          minLength: 2
          maxLength: 120000
          description: Prompt content.
        createdBy:
          type: string
          format: uuid
          nullable: true
          description: User ID of the prompt creator.
        promptFolderId:
          type: string
          format: uuid
          nullable: true
          description: Folder ID the prompt is assigned to.
        sharedWithWorkspace:
          type: boolean
          description: Whether the prompt is shared with the workspace.
        createdAt:
          type: string
          format: date-time
          nullable: true
          description: ISO 8601 timestamp for prompt creation.
        updatedAt:
          type: string
          format: date-time
          nullable: true
          description: ISO 8601 timestamp for the latest prompt update.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: API key as Bearer token. Format "Bearer YOUR_API_KEY"