Dela via

API-referens

DevUI tillhandahåller ett OpenAI-kompatibelt svars-API så att du kan använda OpenAI SDK eller någon HTTP-klient för att interagera med dina agenter och arbetsflöden.

Kommer snart

DevUI-dokumentationen för C# kommer snart. Kom tillbaka senare eller se Python-dokumentationen för konceptuell vägledning.

Bas-webbadress

http://localhost:8080/v1

Porten kan konfigureras med CLI-alternativet --port .

Authentication

DevUI kräver som standard inte autentisering för lokal utveckling. Vid körning med krävs autentisering av --authägartoken.

Använda OpenAI SDK

Grundläggande begäran

from openai import OpenAI

client = OpenAI(
    base_url="http://localhost:8080/v1",
    api_key="not-needed"  # API key not required for local DevUI
)

response = client.responses.create(
    metadata={"entity_id": "weather_agent"},  # Your agent/workflow name
    input="What's the weather in Seattle?"
)

# Extract text from response
print(response.output[0].content[0].text)

Strömmande

response = client.responses.create(
    metadata={"entity_id": "weather_agent"},
    input="What's the weather in Seattle?",
    stream=True
)

for event in response:
    # Process streaming events
    print(event)

Konversationer med flera turer

Använd standardparametern OpenAI conversation för konversationer med flera turer:

# Create a conversation
conversation = client.conversations.create(
    metadata={"agent_id": "weather_agent"}
)

# First turn
response1 = client.responses.create(
    metadata={"entity_id": "weather_agent"},
    input="What's the weather in Seattle?",
    conversation=conversation.id
)

# Follow-up turn (continues the conversation)
response2 = client.responses.create(
    metadata={"entity_id": "weather_agent"},
    input="How about tomorrow?",
    conversation=conversation.id
)

DevUI hämtar automatiskt konversationens meddelandehistorik och skickar den till agenten.

REST API-slutpunkter

Svars-API (OpenAI Standard)

Kör en agent eller ett arbetsflöde:

curl -X POST http://localhost:8080/v1/responses \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {"entity_id": "weather_agent"},
    "input": "What is the weather in Seattle?"
  }'

Konversations-API (OpenAI Standard)

Endpoint Metod Description
/v1/conversations Posten Skapa en konversation
/v1/conversations/{id} GET Hämta konversationsinformation
/v1/conversations/{id} Posten Uppdatera konversationsmetadata
/v1/conversations/{id} DELETE Ta bort en konversation
/v1/conversations?agent_id={id} GET Lista konversationer (DevUI-tillägg)
/v1/conversations/{id}/items Posten Lägga till objekt i konversationen
/v1/conversations/{id}/items GET Lista konversationsobjekt
/v1/conversations/{id}/items/{item_id} GET Hämta ett konversationsobjekt

Entitetshantering (DevUI-tillägg)

Endpoint Metod Description
/v1/entities GET Lista identifierade agenter/arbetsflöden
/v1/entities/{entity_id}/info GET Hämta detaljerad entitetsinformation
/v1/entities/{entity_id}/reload Posten Entitet för snabb inläsning (utvecklarläge)

Hälsokontroll

curl http://localhost:8080/health

Servermetadata

Hämta serverkonfiguration och funktioner:

curl http://localhost:8080/meta

Returnerar:

  • ui_mode - Aktuellt läge (developer eller user)
  • version – DevUI-version
  • framework – Ramverksnamn (agent_framework)
  • runtime – Serverdelskörning (python)
  • capabilities – Funktionsflaggor (spårning, OpenAI-proxy, distribution)
  • auth_required – Om autentisering är aktiverat

Händelsemappning

DevUI mappar Agent Framework-händelser till API-händelser för OpenAI-svar. Tabellen nedan visar mappningen:

Livscykelhändelser

OpenAI-händelse Agent Framework-händelse
response.created + response.in_progress AgentStartedEvent
response.completed AgentCompletedEvent
response.failed AgentFailedEvent
response.created + response.in_progress WorkflowStartedEvent
response.completed WorkflowCompletedEvent
response.failed WorkflowFailedEvent

Innehållstyper

OpenAI-händelse Agent Framework-innehåll
response.content_part.added + response.output_text.delta TextContent
response.reasoning_text.delta TextReasoningContent
response.output_item.added FunctionCallContent (initial)
response.function_call_arguments.delta FunctionCallContent (args)
response.function_result.complete FunctionResultContent
response.output_item.added (bild) DataContent (bilder)
response.output_item.added (fil) DataContent (filer)
error ErrorContent

Arbetsflödeshändelser

OpenAI-händelse Agent Framework-händelse
response.output_item.added (ExecutorActionItem) WorkflowEvent med type="executor_invoked"
response.output_item.done (ExecutorActionItem) WorkflowEvent med type="executor_completed"
response.output_item.added (ResponseOutputMessage) WorkflowEvent med type="output"

Anpassade DevUI-tillägg

DevUI lägger till anpassade händelsetyper för Agent Framework-specifika funktioner:

  • response.function_approval.requested – Begäranden om funktionsgodkännande
  • response.function_approval.responded – Svar om funktionsgodkännande
  • response.function_result.complete – Resultat av funktionskörning på serversidan
  • response.workflow_event.complete – Arbetsflödeshändelser
  • response.trace.complete – Körningsspårningar

Dessa anpassade tillägg är namnrymdsbaserade och kan ignoreras på ett säkert sätt av OpenAI-standardklienter.

OpenAI-proxyläge

DevUI tillhandahåller en OpenAI Proxy-funktion för att testa OpenAI-modeller direkt via gränssnittet utan att skapa anpassade agenter. Aktivera via inställningar i användargränssnittet.

curl -X POST http://localhost:8080/v1/responses \
  -H "X-Proxy-Backend: openai" \
  -d '{"model": "gpt-4.1-mini", "input": "Hello"}'

Anmärkning

Proxyläge kräver OPENAI_API_KEY miljövariabel som konfigurerats på serverdelen.

Nästa steg

  • Last updated on