Справочник по API

DevUI предоставляет API ответов, совместимый с OpenAI, что позволяет использовать пакет SDK OpenAI или любой HTTP-клиент для взаимодействия с агентами и рабочими процессами.

Скоро

В ближайшее время ожидается документация по DevUI для C#. Вернитесь позже или ознакомьтесь с документацией по Python для получения концептуальных рекомендаций.

Базовый URL-адрес

http://localhost:8080/v1

Порт можно настроить с --port помощью параметра CLI.

Authentication

По умолчанию DevUI не требует проверки подлинности для локальной разработки. При запуске с --authпроверкой подлинности маркера носителя требуется.

Использование пакета SDK OpenAI

Базовый запрос

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)

Стриминг

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)

Многоэтапные беседы

Используйте стандартный параметр OpenAI conversation для многоэтапных бесед:

# 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 автоматически извлекает журнал сообщений беседы и передает его агенту.

Конечные точки REST API

API ответов (OpenAI Standard)

Выполните агент или рабочий процесс:

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?"
  }'

API бесед (OpenAI Standard)

конечная точка	Метод	Description
`/v1/conversations`	POST	Создание беседы
`/v1/conversations/{id}`	GET	Получение сведений о беседе
`/v1/conversations/{id}`	POST	Обновление метаданных беседы
`/v1/conversations/{id}`	DELETE	Удаление беседы
`/v1/conversations?agent_id={id}`	GET	Вывод списка бесед (расширение DevUI)
`/v1/conversations/{id}/items`	POST	Добавление элементов в беседу
`/v1/conversations/{id}/items`	GET	Вывод списка элементов беседы
`/v1/conversations/{id}/items/{item_id}`	GET	Получение элемента беседы

Управление сущностями (расширение DevUI)

конечная точка	Метод	Description
`/v1/entities`	GET	Список обнаруженных агентов и рабочих процессов
`/v1/entities/{entity_id}/info`	GET	Получение подробных сведений об сущности
`/v1/entities/{entity_id}/reload`	POST	Горячая перезагрузка сущности (режим разработчика)

Проверка состояния

curl http://localhost:8080/health

Метаданные сервера

Получение конфигурации и возможностей сервера:

curl http://localhost:8080/meta

Returns:

ui_mode — текущий режим (developer или user)
version — Версия DevUI
framework — имя платформы (agent_framework)
runtime — серверная среда выполнения (python)
capabilities — флаги компонентов (трассировка, прокси-сервер OpenAI, развертывание)
auth_required — включена ли проверка подлинности

Сопоставление событий

DevUI сопоставляет события Agent Framework с событиями API OpenAI Responses. В таблице ниже показано сопоставление:

События жизненного цикла

Событие OpenAI	Событие Agent Framework
`response.created` + `response.in_progress`	`AgentStartedEvent`
`response.completed`	`AgentCompletedEvent`
`response.failed`	`AgentFailedEvent`
`response.created` + `response.in_progress`	`WorkflowEvent` С `type="started"`
`response.completed`	`WorkflowEvent` С `type="completed"`
`response.failed`	`WorkflowEvent` С `type="failed"`

Типы контента

Событие OpenAI	Содержимое agent Framework
`response.content_part.added` + `response.output_text.delta`	`Content(type="text")`
`response.reasoning_text.delta`	`Content(type="text_reasoning")`
`response.output_item.added`	`Content(type="function_call")` (инициал)
`response.function_call_arguments.delta`	`Content(type="function_call")` (args)
`response.function_result.complete`	`Content(type="function_result")`
`response.output_item.added` (изображение)	`Content(type="data")` (изображения)
`response.output_item.added` (файл)	`Content(type="data")` (файлы)
`error`	`Content(type="error")`

События рабочего процесса

Событие OpenAI	Событие Agent Framework
`response.output_item.added` (ExecutorActionItem)	`WorkflowEvent` С `type="executor_invoked"`
`response.output_item.done` (ExecutorActionItem)	`WorkflowEvent` С `type="executor_completed"`
`response.output_item.added` (ResponseOutputMessage)	`WorkflowEvent` С `type="output"`

Пользовательские расширения DevUI

DevUI добавляет пользовательские типы событий для функциональных возможностей agent Framework:

response.function_approval.requested - Запросы на утверждение функции
response.function_approval.responded — ответы на утверждение функции
response.function_result.complete — Результаты выполнения функции на стороне сервера
response.workflow_event.completed — события рабочего процесса
response.trace.complete — трассировки выполнения

Эти пользовательские расширения являются пространствами имен и могут быть безопасно проигнорированы стандартными клиентами OpenAI.

Режим прокси-сервера OpenAI

DevUI предоставляет функцию OpenAI Proxy для тестирования моделей OpenAI непосредственно через интерфейс без создания пользовательских агентов. Включите с помощью параметров в пользовательском интерфейсе.

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

Замечание

В режиме прокси-сервера требуется OPENAI_API_KEY переменная среды, настроенная на серверной части.