For the complete documentation index, see llms.txt. This page is also available as Markdown.

Others

FAQ related APIs

List Audit Logs

get
/webapi/v2/audit/logs

Get audit logs with filtering and pagination.

Authorizations
API-KEYstringRequired

Your API key for authentication

Query parameters
createdAtstring · date-timeOptional

Base timestamp (UTC)

beforeRangeinteger · min: 1 · max: 31Optional

Days before created_at (max 31 days)

Default: 31
emailstring · nullableOptional

Agent email filter

apiRequestTypestring · nullableOptional

API request type (rest/graphql)

offsetintegerOptional

Offset for pagination

Default: 0
limitinteger · min: 1 · max: 1000Optional

Limit for pagination

Default: 10
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

OK

application/json

Response model for audit log list.

countintegerRequired

Total count

get/webapi/v2/audit/logs

Download Audit Logs

get
/webapi/v2/audit/logs/download

Download all audit logs as CSV file.

Authorizations
API-KEYstringRequired

Your API key for authentication

Query parameters
createdAtstring · date-timeOptional

Base timestamp (UTC)

beforeRangeinteger · min: 1 · max: 31Optional

Days before created_at (max 31 days)

Default: 31
emailstring · nullableOptional

Agent email filter

apiRequestTypestring · nullableOptional

API request type (rest/graphql)

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

OK

No content

get/webapi/v2/audit/logs/download

No content

Llm 프롬프트 가져오기

get
/webapi/v2/llm_prompts

List custom LLM prompts in the project with pagination and ordering.

Authorizations
API-KEYstringRequired

Your API key for authentication

Query parameters
offsetintegerOptional

Offset of the LLM prompts

Default: 0
limitintegerOptional

Limit of the LLM prompts

Default: 100
orderstring · enumOptionalPossible values:
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

알겠습니다.

application/json
llmPromptIdstringRequired

LLM 프롬프트의 고유 ID

namestringRequired

LLM 프롬프트의 이름

descriptionstring · nullableOptional

LLM 프롬프트에 대한 설명

get/webapi/v2/llm_prompts

Llm 프롬프트 생성

post
/webapi/v2/llm_prompts

Create a custom LLM prompt with messages and dynamic input variables.

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
namestring · nullableRequired

LLM 프롬프트명

descriptionstring · nullableOptional

LLM 프롬프트 설명

Responses
200

알겠습니다

application/json
llmPromptIdstringRequired

LLM 프롬프트의 고유 ID

namestringRequired

LLM 프롬프트의 이름

descriptionstring · nullableOptional

LLM 프롬프트에 대한 설명

post/webapi/v2/llm_prompts

ID로 Llm 프롬프트 가져오기

get
/webapi/v2/llm_prompts/{llm_prompt_id}

Retrieve a single LLM prompt by ID.

Authorizations
API-KEYstringRequired

Your API key for authentication

Path parameters
llm_prompt_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

알겠습니다.

application/json
llmPromptIdstringRequired

LLM 프롬프트의 고유 ID

namestringRequired

LLM 프롬프트의 이름

descriptionstring · nullableOptional

LLM 프롬프트에 대한 설명

get/webapi/v2/llm_prompts/{llm_prompt_id}

ID로 Llm 프롬프트 삭제

delete
/webapi/v2/llm_prompts/{llm_prompt_id}

Soft-delete an LLM prompt. Fails if the prompt is currently used by a campaign.

Authorizations
API-KEYstringRequired

Your API key for authentication

Path parameters
llm_prompt_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

알겠습니다

No content

delete/webapi/v2/llm_prompts/{llm_prompt_id}

No content

ID로 Llm 프롬프트 설정

patch
/webapi/v2/llm_prompts/{llm_prompt_id}

Partially update an LLM prompt. Only provided fields are changed.

Authorizations
API-KEYstringRequired

Your API key for authentication

Path parameters
llm_prompt_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
namestring · nullableRequired

LLM 프롬프트명

descriptionstring · nullableOptional

LLM 프롬프트 설명

Responses
200

알겠습니다

application/json
llmPromptIdstringRequired

LLM 프롬프트의 고유 ID

namestringRequired

LLM 프롬프트의 이름

descriptionstring · nullableOptional

LLM 프롬프트에 대한 설명

patch/webapi/v2/llm_prompts/{llm_prompt_id}

Trigger Directory Integration

post
/webapi/v2/directory_integration/trigger

Trigger directory integration for the specified path or folder.

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

Request entity for triggering directory integration.

directory_pathstring · nullableOptional

Path to directory to integrate

folder_idstring · nullableOptional

ID of folder to sync

Responses
200

OK

application/json

Response entity for directory integration trigger.

successbooleanRequired

Whether the integration was successfully triggered

messagestringRequired

Response message

task_idstring · nullableOptional

Task ID for tracking the operation

post/webapi/v2/directory_integration/trigger

Get App Call Statistics

get
/webapi/v2/analytics/app_statistic_history

Get LLM app call history statistics by period.

Authorizations
API-KEYstringRequired

Your API key for authentication

Query parameters
startDatestringRequired

Start date in YYYY-MM-DD format

endDatestringRequired

End date in YYYY-MM-DD format

metricNamestring · enumOptionalPossible values:
llmAppIdstring · nullableOptional

LLM app ID

llmAppCategorystring · nullableOptional

LLM app category

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

OK

application/json

Response model for usage history statistics.

get/webapi/v2/analytics/app_statistic_history

Get LLM Call Statistics

get
/webapi/v2/analytics/llm_statistic_history

Get LLM call history statistics by period.

Authorizations
API-KEYstringRequired

Your API key for authentication

Query parameters
startDatestringRequired

Start date in YYYY-MM-DD format

endDatestringRequired

End date in YYYY-MM-DD format

metricNamestring · enumOptionalPossible values:
llmModelstring · nullableOptional

LLM model

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

OK

application/json

Response model for usage history statistics.

get/webapi/v2/analytics/llm_statistic_history

미디어 콘텐츠 조회

post
/webapi/v2/multimodal/media-content

저장된 미디어 항목의 내용을 base64 인코딩 문자열로 조회합니다. media_id는 upload_media 엔드포인트가 반환한 ID에 해당합니다. 인증된 프로젝트에서 미디어를 찾을 수 없으면 null 콘텐츠를 반환합니다. 인증을 위해 API-KEY 헤더가 필요합니다.

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

Request body for retrieving media content.

media_idstringRequired

The ID of the media to retrieve content for.

media_typestring · enumOptional

The type of media to retrieve.

Default: imagePossible values:
Responses
200

OK

application/json

Response containing base64-encoded media content.

contentstring · nullableRequired

Base64-encoded media content, or null if the media was not found.

post/webapi/v2/multimodal/media-content

파일 생성

post
/webapi/v2/multimodal/generate-file

마크다운 콘텐츠를 다운로드 가능한 문서(PDF, DOCX, PPTX, XLSX)로 변환합니다. 성공 시 파일 이름과 다운로드 URL을, 실패 시 에러 상세 정보를 반환합니다. 인증을 위해 API-KEY 헤더가 필요합니다.

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

Request body for generating a downloadable file.

userIdstringRequired

ID of the user requesting file generation.

titlestringRequired

Title of the generated document.

fileFormatstring · enumRequired

Output file format.

Possible values:
markdownTextstringRequired

Markdown content to convert into the document.

Responses
200

OK

application/json

Response containing the generated file location or error details.

fileNamestring · nullableOptional

Name of the generated file.

fileUrlstring · nullableOptional

Download URL of the generated file.

errorstring · nullableOptional

Error code, present only on failure.

errorMessagestring · nullableOptional

Human-readable error description.

post/webapi/v2/multimodal/generate-file

동의어 조회

post
/webapi/v2/synonyms/

프로젝트 내 주어진 질문들에 대한 동의어 타겟과 그 동의어들을 반환합니다.

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
questionsstring[]Required
Responses
200

OK

application/json
post/webapi/v2/synonyms/

프로젝트 조회

get
/webapi/v2/projects

API-KEY로 식별된 프로젝트를 반환합니다.

Ralli가 로그인 후 프로젝트 정보(id, name, cognitiveSearchApiKey)를 가져올 때 사용합니다.

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

OK

application/json
itemsanyOptional
get/webapi/v2/projects

Get Credit Balance

get
/webapi/v2/credits/balance

Return the project's credit balance summary.

Trial info and monthly cap info are always project-cumulative. When both startDate and endDate are supplied, totalCreditUsage is the sum consumed within that range and byCategory provides the per-category breakdown for the same range. Without dates, totalCreditUsage is the project lifetime cumulative usage.

Authorizations
API-KEYstringRequired

Your API key for authentication

Query parameters
startDatestring · nullableOptional

Start date (UTC, inclusive) in YYYY-MM-DD. Required together with endDate.

Example: 2025-04-01Pattern: ^\d{4}-\d{2}-\d{2}$
endDatestring · nullableOptional

End date (UTC, inclusive) in YYYY-MM-DD. Required together with startDate.

Example: 2025-04-30Pattern: ^\d{4}-\d{2}-\d{2}$
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

OK

application/json

Response body for GET /webapi/v2/credits/balance.

totalCreditUsagenumberRequired

Cumulative credit consumed by the project across all time.

Example: 1234.5
get/webapi/v2/credits/balance

요약 분석

get
/webapi/summary_analytics

프로젝트를 위한 다양한 요약된 분석 정보를 제공합니다.

Authorizations
API-KEYstringRequired

Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
startDatestringOptional

YYYY-MM-DD 형식으로 조회할 날짜 범위의 시작.

endDatestringOptional

질의할 날짜 범위의 끝을 YYYY-MM-DD 형식으로 입력해 주세요.

Responses
200

분석 데이터 검색에 성공했습니다.

application/json
errorsobject · nullableOptional
get/webapi/summary_analytics

Last updated