For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
기본 탐색 메뉴
Theme

에이전트 API

관리형 Codex 하네스로 세션 상태를 유지하는 클라우드 에이전트를 구축하세요.

에이전트 API를 사용하면 애플리케이션에서 OpenAI가 관리하는 API를 통해 Codex 하네스에 접근할 수 있습니다.

OpenAI는 세션, 오케스트레이션, 컨텍스트 압축, 복구를 관리합니다. 애플리케이션은 에이전트가 사용할 도구를 제공하고 실행 환경을 선택합니다.

에이전트는 샌드박스에서 코드를 실행하고, 파일을 편집하고, MCP 서버에 연결하고, 아티팩트를 생성할 수 있습니다.

엔드포인트, 요청 매개변수, 응답 필드는 API 레퍼런스를 참고하세요.

요금

모델 사용량에는 선택한 모델의 API 요금이 적용됩니다. OpenAI 도구에는 표준 도구 요금이, OpenAI 호스팅 샌드박스에는 표준 컨테이너 요금이 적용됩니다.

예제 실행하기

다음 예제를 직접 실행해 보세요.

완성된 애플리케이션 예제도 살펴보세요.

핵심 개념

에이전트 API에는 네 가지 핵심 개념이 있습니다.

  • 에이전트: 에이전트가 사용할 수 있는 모델, 지침, 도구, MCP 서버를 정의합니다.
  • 환경: 에이전트가 파일에 접근하고 스킬을 불러오고 명령어를 실행하는 샌드박스 또는 컴퓨터입니다. 환경은 선택 사항입니다.
  • 세션: 상태를 유지하면서 작업을 수행하고 입력에 응답하는 에이전트 인스턴스입니다.
  • 이벤트와 항목: 에이전트에 보낸 입력과 세션 중에 생성된 출력입니다.

세션의 전체 흐름

빠른 시작에서 OpenAI 호스팅 샌드박스로 시작하세요.

  1. 세션을 생성하세요. 에이전트를 구성하면 OpenAI가 실행 환경을 프로비저닝합니다.
  2. 작업을 전달하세요. 환경이 준비된 상태에서 사용자가 입력을 보내면 작업 턴이 시작됩니다.
  3. 진행 상황을 확인하세요. 출력을 스트리밍하거나 웹훅을 사용하면 에이전트가 작업을 마치거나 추가 입력이 필요한 시점을 알 수 있습니다.
  4. 작업을 이어가거나 방향을 조정하세요. 같은 세션에 다른 작업을 보내거나 현재 턴이 진행되는 동안 에이전트에 추가 지시를 보내세요.

OpenAI 호스팅 세션에서는 애플리케이션이 입력을 보내고 이벤트를 받습니다. OpenAI는 에이전트를 실행하고 샌드박스를 프로비저닝하고 관리합니다. 설정 방법과 제한 사항은 환경 옵션을 참고하세요.

애플리케이션은 세션을 시작하고 에이전트 API에서 이벤트와 출력을 받습니다. OpenAI는 관리형 Codex 하네스를 실행하고 샌드박스를 프로비저닝하고 관리합니다.

관리형 하네스가 제공하는 기능

관리형 Codex 하네스는 다음 기능을 지원합니다.

  • 샌드박스에서 명령어와 코드 실행
  • 작업에 맞는 스킬과 지침 적용
  • 도구 또는 MCP를 통한 외부 데이터 연결
  • 작업 중인 에이전트에 추가 지시 전달
  • 이전 작업을 요약해 컨텍스트 윈도우 관리
  • 작업을 하위 작업으로 나누어 하위 에이전트에 위임
  • 중단한 지점부터 세션 재개

API 키에 필요한 권한과 SDK 설정 방법은 빠른 시작의 사전 요구 사항을 확인하세요. 세션을 생성할 때 다음과 같이 기능을 구성하세요.

관리형 하네스 기능 구성
from openai import OpenAI

client = OpenAI()

session = client.beta.agents.sessions.create(
    agent={
        "model": "gpt-6-astra",
        "instructions": "Use the OpenAI documentation MCP and web search to answer technical questions accurately. Delegate independent research tasks to subagents when useful.",
        "tools": [
            {"type": "programmatic_tool_calling"},
            {
                "type": "mcp",
                "server_label": "openai_docs",
                "transport": {
                    "type": "http",
                    "server_url": "https://developers.openai.com/mcp",
                },
            },
            {"type": "web_search"},
        ],
        "multi_agent": {"enabled": True, "max_concurrent_subagents": 4},
    },
    environment={
        "type": "self_hosted",
        "workspace_directory": "/workspace",
        "capability_directories": ["/workspace/capabilities/skills"],
    },
    input=[
        {
            "role": "user",
            "content": [
                {
                    "type": "input_text",
                    "text": "Research how to connect an MCP server to an OpenAI agent, check for recent updates, and summarize the recommended setup.",
                }
            ],
        }
    ],
)
print(session.id)

런타임별 차이는 에이전트 개요를 참고하세요.

에이전트 API를 기반으로 구축된 AWS 서비스에 대해서는 Bedrock Managed Agents를 참고하세요.

에이전트 API는 세션 상태를 유지하므로 대화 컨텍스트를 다시 구성할 필요 없이 다음 턴에서 작업을 이어갈 수 있습니다. 세션과 게시된 아티팩트는 더 이상 필요하지 않을 때 삭제할 수 있습니다. 현재 에이전트 API는 미국에서만 데이터 레지던시를 지원하며, 데이터 비보관(ZDR)은 지원하지 않습니다. 자체 호스팅 샌드박스를 선택해도 에이전트 API에는 ZDR을 적용할 수 없습니다. 데이터 레지던시와 보관에 관한 자세한 내용은 OpenAI 플랫폼의 데이터 제어를 참고하세요.