メインコンテンツへスキップ
POST
/
v1
/
schedules
スケジュール作成
curl --request POST \
  --url https://api.olostep.com/v1/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "GET",
  "endpoint": "<string>",
  "payload": {},
  "cron_expression": "<string>",
  "execute_at": "2023-11-07T05:31:56Z",
  "expression_timezone": "<string>",
  "text": "<string>"
}
'
{
  "id": "<string>",
  "type": "recurring",
  "method": "GET",
  "endpoint": "<string>",
  "cron_expression": "<string>",
  "execute_at": "2023-11-07T05:31:56Z",
  "expression_timezone": "<string>",
  "created": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.olostep.com/llms.txt

Use this file to discover all available pages before exploring further.

承認

​
Authorization
string
header
必須

Bearer認証ヘッダーの形式はBearer で、はあなたの認証トークンです。

ボディ

application/json
​
method
enum<string>
必須

スケジュールされたAPIコールのHTTPメソッド。GETまたはPOSTのいずれかでなければなりません。

利用可能なオプション:
GET,
POST
​
endpoint
string
必須

スケジュールが実行されるときに呼び出されるエンドポイントURL。Olostepエンドポイントを使用したPOSTリクエストの場合、短縮形（例: 'v1/scrapes', 'v1/batches', 'v1/crawls', 'v1/maps', 'v1/answers'）を使用することができ、自動的に'https://api.olostep.com/'がプレフィックスされます。他のエンドポイントの場合は、完全なURLを提供してください。

​
payload
object

APIコールと共に送信するペイロード。必要な任意のJSON構造を含めることができます。GETリクエストの場合、通常は空です。POSTリクエストの場合、エンドポイントに送信したいデータを含める必要があります。

​
cron_expression
string

定期的なスケジュールのための6フィールド形式のcron式（分 時 日 月 曜日 年）。定期的なスケジュールには必須です。execute_atおよびtextとは相互排他的です。

​
execute_at
string<date-time>

一度きりのスケジュール実行のためのISO 8601日時文字列。有効な未来の日時でなければなりません。一度きりのスケジュールには必須です。cron_expressionとは相互排他的です。

​
expression_timezone
string

スケジュールのためのIANAタイムゾーン識別子（例: 'UTC', 'America/New_York', 'Europe/London'）。定期的なスケジュールには必須で、一度きりのスケジュールにはオプションです。自然言語テキストを使用する場合、デフォルトは'UTC'です。

​
text
string

自動的にcron式を生成するための自然言語テキスト。システムはあなたのテキストを有効なcron式に変換します。例: 'every 3 minutes', 'every day at 10am', 'every Monday at 9am'。cron_expressionおよびexecute_atとは相互排他的です。使用する場合、expression_timezoneのデフォルトは'UTC'です。

レスポンス

スケジュールが正常に作成されました。

​
id
string

ユニークなスケジュール識別子

​
type
enum<string>

スケジュールのタイプ: cronベースのスケジュールには'recurring'、単一実行スケジュールには'onetime'

利用可能なオプション:
recurring,
onetime
​
method
enum<string>

スケジュールされたコールのHTTPメソッド

利用可能なオプション:
GET,
POST
​
endpoint
string

呼び出されるエンドポイントURL

​
cron_expression
string

Cron式（定期的なスケジュールの場合のみ存在）

​
execute_at
string<date-time>

実行日時（一度きりのスケジュールの場合のみ存在）

​
expression_timezone
string

スケジュールのタイムゾーン

​
created
string<date-time>

スケジュールが作成されたISO 8601日時