{ "openapi": "3.0.1", "info": { "title": "Music Catalog Reconciliation", "description": "Compare your recording catalog with registration exports, review missing or conflicting song links, and download the corrections you approve.", "version": "2.0", "x-build-id": "I9jgJ5ouaY62xISCL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sabya-services~music-catalog-reconciliation/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sabya-services-music-catalog-reconciliation", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/sabya-services~music-catalog-reconciliation/runs": { "post": { "operationId": "runs-sync-sabya-services-music-catalog-reconciliation", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/sabya-services~music-catalog-reconciliation/run-sync": { "post": { "operationId": "run-sync-sabya-services-music-catalog-reconciliation", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "contractVersion", "rightsToProcessConfirmed" ], "properties": { "contractVersion": { "title": "Input layout", "enum": [ "1.0", "2.0" ], "type": "string", "description": "Choose Catalog files for preview, file uploads and reviewed exports. Choose CSV text pair to use the two CSV boxes near the bottom of this form.", "default": "1.0" }, "rightsToProcessConfirmed": { "title": "I am authorized to process these files", "type": "boolean", "description": "Confirm you have the rights and permissions to process the catalog and registration data you supply. Required before processing or charging." }, "nativeForm": { "title": "Use file upload form", "type": "boolean", "description": "Keep checked to use the catalog, registration export and review fields below. Select Catalog files as the input layout." }, "mode": { "title": "What would you like to do?", "enum": [ "preview", "reconcile", "reviewedExport" ], "type": "string", "description": "Preview checks your files and estimates the maximum comparison price without matching or audit events. Reconcile starts a fresh paid comparison. Export reviewed matches uses an existing audit with no new audit events." }, "runLabel": { "title": "Run label", "maxLength": 200, "type": "string", "description": "An optional name to help you recognize this comparison. Avoid confidential details." }, "catalogText": { "title": "Catalog text", "type": "string", "description": "Paste CSV, TSV, a JSON array or NDJSON. Replace the example with your data, or clear this box before uploading a file or selecting a private record. Keep identifiers as text." }, "catalogUpload": { "title": "Catalog upload", "type": "string", "description": "Upload into an existing store explicitly set to Restricted, then select that same store below to grant Limited access. Use the Apify private-record upload link without a query or fragment. Stores that inherit account access settings must be set to Restricted before use." }, "catalogStore": { "title": "Catalog private store", "type": "string", "description": "Choose the explicitly Restricted store holding this file. For an upload, select the same store used above. The selection grants read access; API inputs need this selector too." }, "catalogKey": { "title": "Catalog record key", "type": "string", "description": "Enter the file record key when reading from the selected store, for example catalog.csv." }, "catalogFormat": { "title": "Catalog file format", "enum": [ "auto", "csv", "tsv", "json", "ndjson" ], "type": "string", "description": "Use auto to detect CSV, TSV, JSON or NDJSON, or select the format yourself. Export Excel worksheets as CSV before uploading." }, "catalogHeaderRow": { "title": "Catalog header row", "minimum": 1, "maximum": 50, "type": "integer", "description": "For CSV/TSV, enter the row containing column names (1–50). Leave empty to use the first row." }, "catalogMapping": { "title": "Catalog column names (optional)", "type": "object", "description": "Common header names are recognized automatically. For missing or ambiguous columns, enter the exact header from your file. A vendor work_id is not an MLC Song Code.", "properties": { "catalog_id": { "title": "Catalog ID", "type": "string", "editor": "textfield", "description": "Enter the header containing Catalog ID. Leave empty to use recognized column names." }, "isrc": { "title": "ISRC", "type": "string", "editor": "textfield", "description": "Enter the header containing ISRC. Leave empty to use recognized column names." }, "title": { "title": "Title", "type": "string", "editor": "textfield", "description": "Enter the header containing Title. Leave empty to use recognized column names." }, "artist": { "title": "Artist", "type": "string", "editor": "textfield", "description": "Enter the header containing Artist. Leave empty to use recognized column names." }, "version": { "title": "Recording version", "type": "string", "editor": "textfield", "description": "Enter the header containing Recording version. Leave empty to use recognized column names." }, "writer_ipis": { "title": "Writer IPIs", "type": "string", "editor": "textfield", "description": "Enter the header containing Writer IPIs. Leave empty to use recognized column names." }, "iswc": { "title": "ISWC", "type": "string", "editor": "textfield", "description": "Enter the header containing ISWC. Leave empty to use recognized column names." }, "mlc_song_code": { "title": "MLC Song Code", "type": "string", "editor": "textfield", "description": "Enter the header containing MLC Song Code. Leave empty to use recognized column names." } } }, "reference1Text": { "title": "Registration export 1 text", "type": "string", "description": "Paste CSV, TSV, a JSON array or NDJSON. Replace the example with your data, or clear this box before uploading a file or selecting a private record. Keep identifiers as text." }, "reference1Upload": { "title": "Registration export 1 upload", "type": "string", "description": "Upload into an existing store explicitly set to Restricted, then select that same store below to grant Limited access. Use the Apify private-record upload link without a query or fragment. Stores that inherit account access settings must be set to Restricted before use." }, "reference1Store": { "title": "Registration export 1 private store", "type": "string", "description": "Choose the explicitly Restricted store holding this file. For an upload, select the same store used above. The selection grants read access; API inputs need this selector too." }, "reference1Key": { "title": "Registration export 1 record key", "type": "string", "description": "Enter the file record key when reading from the selected store, for example catalog.csv." }, "reference1Format": { "title": "Registration export 1 file format", "enum": [ "auto", "csv", "tsv", "json", "ndjson" ], "type": "string", "description": "Use auto to detect CSV, TSV, JSON or NDJSON, or select the format yourself. Export Excel worksheets as CSV before uploading." }, "reference1HeaderRow": { "title": "Registration export 1 header row", "minimum": 1, "maximum": 50, "type": "integer", "description": "For CSV/TSV, enter the row containing column names (1–50). Leave empty to use the first row." }, "reference1Mapping": { "title": "Registration export 1 column names (optional)", "type": "object", "description": "Common header names are recognized automatically. For missing or ambiguous columns, enter the exact header from your file. A vendor work_id is not an MLC Song Code.", "properties": { "reference_id": { "title": "Reference row ID", "type": "string", "editor": "textfield", "description": "Enter the header containing Reference row ID. Leave empty to use recognized column names." }, "mlc_song_code": { "title": "MLC Song Code", "type": "string", "editor": "textfield", "description": "Enter the header containing MLC Song Code. Leave empty to use recognized column names." }, "iswc": { "title": "ISWC", "type": "string", "editor": "textfield", "description": "Enter the header containing ISWC. Leave empty to use recognized column names." }, "title": { "title": "Title", "type": "string", "editor": "textfield", "description": "Enter the header containing Title. Leave empty to use recognized column names." }, "writer_ipis": { "title": "Writer IPIs", "type": "string", "editor": "textfield", "description": "Enter the header containing Writer IPIs. Leave empty to use recognized column names." }, "isrc": { "title": "ISRC", "type": "string", "editor": "textfield", "description": "Enter the header containing ISRC. Leave empty to use recognized column names." }, "version": { "title": "Recording version", "type": "string", "editor": "textfield", "description": "Enter the header containing Recording version. Leave empty to use recognized column names." }, "registration_status": { "title": "Registration status", "type": "string", "editor": "textfield", "description": "Enter the header containing Registration status. Leave empty to use recognized column names." } } }, "reference1Id": { "title": "Registration export 1 ID", "type": "string", "description": "Use a short unique ID for this source, with letters, numbers, underscores or hyphens. Keep it the same when comparing later exports." }, "reference1Label": { "title": "Registration export 1 name", "type": "string", "description": "Give this export a recognizable name. If left empty, the report uses Customer reference." }, "reference1AsOf": { "title": "Registration export 1 date", "type": "string", "description": "Optional export date in YYYY-MM-DD format. This records the date you supply; it does not verify registration status." }, "reference2Text": { "title": "Registration export 2 text", "type": "string", "description": "Paste CSV, TSV, a JSON array or NDJSON. Leave this box empty when uploading a file or selecting a private record. Keep identifiers as text." }, "reference2Upload": { "title": "Registration export 2 upload", "type": "string", "description": "Upload into an existing store explicitly set to Restricted, then select that same store below to grant Limited access. Use the Apify private-record upload link without a query or fragment. Stores that inherit account access settings must be set to Restricted before use." }, "reference2Store": { "title": "Registration export 2 private store", "type": "string", "description": "Choose the explicitly Restricted store holding this file. For an upload, select the same store used above. The selection grants read access; API inputs need this selector too." }, "reference2Key": { "title": "Registration export 2 record key", "type": "string", "description": "Enter the file record key when reading from the selected store, for example catalog.csv." }, "reference2Format": { "title": "Registration export 2 file format", "enum": [ "auto", "csv", "tsv", "json", "ndjson" ], "type": "string", "description": "Use auto to detect CSV, TSV, JSON or NDJSON, or select the format yourself. Export Excel worksheets as CSV before uploading." }, "reference2HeaderRow": { "title": "Registration export 2 header row", "minimum": 1, "maximum": 50, "type": "integer", "description": "For CSV/TSV, enter the row containing column names (1–50). Leave empty to use the first row." }, "reference2Mapping": { "title": "Registration export 2 column names (optional)", "type": "object", "description": "Common header names are recognized automatically. For missing or ambiguous columns, enter the exact header from your file. A vendor work_id is not an MLC Song Code.", "properties": { "reference_id": { "title": "Reference row ID", "type": "string", "editor": "textfield", "description": "Enter the header containing Reference row ID. Leave empty to use recognized column names." }, "mlc_song_code": { "title": "MLC Song Code", "type": "string", "editor": "textfield", "description": "Enter the header containing MLC Song Code. Leave empty to use recognized column names." }, "iswc": { "title": "ISWC", "type": "string", "editor": "textfield", "description": "Enter the header containing ISWC. Leave empty to use recognized column names." }, "title": { "title": "Title", "type": "string", "editor": "textfield", "description": "Enter the header containing Title. Leave empty to use recognized column names." }, "writer_ipis": { "title": "Writer IPIs", "type": "string", "editor": "textfield", "description": "Enter the header containing Writer IPIs. Leave empty to use recognized column names." }, "isrc": { "title": "ISRC", "type": "string", "editor": "textfield", "description": "Enter the header containing ISRC. Leave empty to use recognized column names." }, "version": { "title": "Recording version", "type": "string", "editor": "textfield", "description": "Enter the header containing Recording version. Leave empty to use recognized column names." }, "registration_status": { "title": "Registration status", "type": "string", "editor": "textfield", "description": "Enter the header containing Registration status. Leave empty to use recognized column names." } } }, "reference2Id": { "title": "Registration export 2 ID", "type": "string", "description": "Use a short unique ID for this source, with letters, numbers, underscores or hyphens. Keep it the same when comparing later exports." }, "reference2Label": { "title": "Registration export 2 name", "type": "string", "description": "Enter a name to include this additional export. Leave empty to skip it." }, "reference2AsOf": { "title": "Registration export 2 date", "type": "string", "description": "Optional export date in YYYY-MM-DD format. This records the date you supply; it does not verify registration status." }, "reference3Text": { "title": "Registration export 3 text", "type": "string", "description": "Paste CSV, TSV, a JSON array or NDJSON. Leave this box empty when uploading a file or selecting a private record. Keep identifiers as text." }, "reference3Upload": { "title": "Registration export 3 upload", "type": "string", "description": "Upload into an existing store explicitly set to Restricted, then select that same store below to grant Limited access. Use the Apify private-record upload link without a query or fragment. Stores that inherit account access settings must be set to Restricted before use." }, "reference3Store": { "title": "Registration export 3 private store", "type": "string", "description": "Choose the explicitly Restricted store holding this file. For an upload, select the same store used above. The selection grants read access; API inputs need this selector too." }, "reference3Key": { "title": "Registration export 3 record key", "type": "string", "description": "Enter the file record key when reading from the selected store, for example catalog.csv." }, "reference3Format": { "title": "Registration export 3 file format", "enum": [ "auto", "csv", "tsv", "json", "ndjson" ], "type": "string", "description": "Use auto to detect CSV, TSV, JSON or NDJSON, or select the format yourself. Export Excel worksheets as CSV before uploading." }, "reference3HeaderRow": { "title": "Registration export 3 header row", "minimum": 1, "maximum": 50, "type": "integer", "description": "For CSV/TSV, enter the row containing column names (1–50). Leave empty to use the first row." }, "reference3Mapping": { "title": "Registration export 3 column names (optional)", "type": "object", "description": "Common header names are recognized automatically. For missing or ambiguous columns, enter the exact header from your file. A vendor work_id is not an MLC Song Code.", "properties": { "reference_id": { "title": "Reference row ID", "type": "string", "editor": "textfield", "description": "Enter the header containing Reference row ID. Leave empty to use recognized column names." }, "mlc_song_code": { "title": "MLC Song Code", "type": "string", "editor": "textfield", "description": "Enter the header containing MLC Song Code. Leave empty to use recognized column names." }, "iswc": { "title": "ISWC", "type": "string", "editor": "textfield", "description": "Enter the header containing ISWC. Leave empty to use recognized column names." }, "title": { "title": "Title", "type": "string", "editor": "textfield", "description": "Enter the header containing Title. Leave empty to use recognized column names." }, "writer_ipis": { "title": "Writer IPIs", "type": "string", "editor": "textfield", "description": "Enter the header containing Writer IPIs. Leave empty to use recognized column names." }, "isrc": { "title": "ISRC", "type": "string", "editor": "textfield", "description": "Enter the header containing ISRC. Leave empty to use recognized column names." }, "version": { "title": "Recording version", "type": "string", "editor": "textfield", "description": "Enter the header containing Recording version. Leave empty to use recognized column names." }, "registration_status": { "title": "Registration status", "type": "string", "editor": "textfield", "description": "Enter the header containing Registration status. Leave empty to use recognized column names." } } }, "reference3Id": { "title": "Registration export 3 ID", "type": "string", "description": "Use a short unique ID for this source, with letters, numbers, underscores or hyphens. Keep it the same when comparing later exports." }, "reference3Label": { "title": "Registration export 3 name", "type": "string", "description": "Enter a name to include this additional export. Leave empty to skip it." }, "reference3AsOf": { "title": "Registration export 3 date", "type": "string", "description": "Optional export date in YYYY-MM-DD format. This records the date you supply; it does not verify registration status." }, "auditStore": { "title": "Existing audit private store", "type": "string", "description": "Use the complete audit.json from the comparison you reviewed. A history snapshot cannot authorize exports. Select its explicitly Restricted store to grant read access, or paste JSON below." }, "auditKey": { "title": "Existing audit record key", "type": "string", "description": "Enter the JSON record key in the selected private store." }, "auditText": { "title": "Existing audit JSON text", "type": "string", "description": "Use the complete audit.json from the comparison you reviewed. A history snapshot cannot authorize exports. Paste the JSON here instead of selecting a store record." }, "profileStore": { "title": "Saved column mapping private store", "type": "string", "description": "Reuse mapping-profile.json from a preview. Changed file layouts need a new mapping; fields entered above take precedence. Select its explicitly Restricted store to grant read access, or paste JSON below." }, "profileKey": { "title": "Saved column mapping record key", "type": "string", "description": "Enter the JSON record key in the selected private store." }, "profileText": { "title": "Saved column mapping JSON text", "type": "string", "description": "Reuse mapping-profile.json from a preview. Changed file layouts need a new mapping; fields entered above take precedence. Paste the JSON here instead of selecting a store record." }, "previousStore": { "title": "Earlier comparison private store", "type": "string", "description": "Use an earlier history.json to compare findings. Previous approvals do not authorize new exports. Select its explicitly Restricted store to grant read access, or paste JSON below." }, "previousKey": { "title": "Earlier comparison record key", "type": "string", "description": "Enter the JSON record key in the selected private store." }, "previousText": { "title": "Earlier comparison JSON text", "type": "string", "description": "Use an earlier history.json to compare findings. Previous approvals do not authorize new exports. Paste the JSON here instead of selecting a store record." }, "decisionsText": { "title": "Completed decisions CSV", "type": "string", "description": "Paste rows from decisions-template.csv, with APPROVE, REJECT or DEFER for each pair you reviewed. Approvals must belong to the supplied audit and need the review confirmation below." }, "historyStore": { "title": "Save comparison history (optional)", "type": "string", "description": "Choose an explicitly Restricted private store to save a separate history record for each run. This grants read and write access; records are not automatically deleted." }, "previousHistoryKey": { "title": "Earlier history record key", "type": "string", "description": "Enter the exact mcr-history--.json key to compare with. The latest/index records do not automatically select an earlier comparison." }, "reviewedMatchesConfirmed": { "title": "I reviewed these match suggestions", "type": "boolean", "description": "Confirm your review before downloading approved pairs. The file has ISRC and MLC Song Code columns; nothing is submitted to The MLC or another registry.", "default": false }, "catalogCsv": { "title": "Recording catalog CSV text", "type": "string", "description": "For the CSV text pair layout: paste comma-separated UTF-8 CSV with a header row. Required columns: catalog_id, isrc, title. Optional: artist, version, writer_ipis (semicolon-separated), iswc, mlc_song_code. Limit: 2,000 rows / 1 MiB." }, "registrationsCsv": { "title": "Registration export CSV text", "type": "string", "description": "For the CSV text pair layout: paste your comma-separated UTF-8 registration export. Required columns: reference_id, mlc_song_code, title. Optional: iswc, writer_ipis, isrc, version, registration_status. Limit: 10,000 rows / 3 MiB." }, "referenceSource": { "title": "Registration export name", "maxLength": 200, "type": "string", "description": "For the CSV text pair: give the export a short name so you can identify its source in the report. The source is supplied by you and is not independently verified." }, "referenceAsOf": { "title": "Registration export date", "type": "string", "description": "For the CSV text pair: enter the export date as YYYY-MM-DD, or a date-time with timezone." }, "columnMapping": { "title": "CSV text column names (optional)", "type": "object", "description": "For the CSV text pair: map fields to your headers, for example {\"catalog\":{\"isrc\":\"ISRC Code\"},\"registrations\":{\"mlc_song_code\":\"Song Code\"}}. Identifier columns are never guessed." }, "previousAuditJson": { "title": "Earlier CSV comparison (optional)", "type": "string", "description": "For the CSV text pair: paste its earlier history.json or audit.json, up to 1 MiB. Comparisons need the same matching rules; incompatible evidence is marked NOT_COMPARABLE." }, "approvedMatchesCsv": { "title": "CSV text match approvals (optional)", "type": "string", "description": "For the CSV text pair: use isrc,mlc_song_code columns containing current-run SUPPLIED_LINK_AGREES or CANDIDATE_REVIEW suggestions. Confirm review above. Invalid, blank, duplicate or stale rows stop before charging. Limit: 2,000 rows / 256 KiB. This starts a fresh comparison; use Export reviewed matches with a file audit to avoid buying another comparison." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }