API Reference

const response = await fetch('/pipelines/65b3db5c8c997c4ce3c4efb3', {
	method: 'GET',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/pipelines?limit=10&sort=times_used&order=-1', {
	method: 'GET',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/pipelines?template=false', {
	method: 'POST',
	body: JSON.stringify({
		name: 'Pipeline Name',
		description: 'A simple pipeline to count annotations.',
		components: [{
			name: 'Counter',
			driver: 'DUUIUIMADriver',
			target: 'org.texttechnologylab.DockerUnifiedUIMAInterface.tools.CountAnnotations',
			options: {
				scale: 2
			}
		}],
	}),
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/pipelines/65b3db5c8c997c4ce3c4efb3/start', {
	method: 'POST',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/pipelines/65b3db5c8c997c4ce3c4efb3/stop', {
	method: 'PUT',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/pipelines/65b3db5c8c997c4ce3c4efb3', {
	method: 'PUT',
	body: JSON.strinfigy({
		name: 'New Name'
	})
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/pipelines/65b3db5c8c997c4ce3c4efb3', {
	method: 'DELETE',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/components/65b3db5c8c997c4ce3c4efb3', {
	method: 'GET',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/components?limit=5&sort=name&order=1', {
	method: 'GET',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/components', {
	method: 'POST',
	body: JSON.stringify({
		pipeline_id: '65b3db5c8c997c4ce3c4efb3',
		name: 'Component Name',
		description: 'A simple component for tokenization.',
		driver: 'DUUIUIMADriver',
		target: 'de.tudarmstadt.ukp.dkpro.core.tokit.BreakIteratorSegmenter',
		options: {
			scale: 1,
			use_GPU: true,
			docker_image_fetching: true,
			host: null,
			registry_auth: {
				username: null,
				password: null
			},
			keep_alive: false,
			ignore_200_error: true,
			constraint: [],
			labels: []
		}
	}),
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/components/65b3db5c8c997c4ce3c4efb3', {
	method: 'PUT',
	body: JSON.strinfigy({
		name: 'New Name'
	})
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/components/65b3db5c8c997c4ce3c4efb3', {
	method: 'DELETE',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/processes/65b3dba48c997c4ce3c4f09e', {
	method: 'GET',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/processes?pipeline_id=65b3db5c8c997c4ce3c4efb3&limit=10&sort=input.provider&order=-1status=Completed;Failed', {
	method: 'GET',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/processes?status=Completed;Failed&search=example.txt&sort=size&limit=3', {
	method: 'GET',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/pipelines/65b3dba48c997c4ce3c4f09e', {
	method: 'GET',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/processes', {
	method: 'POST',
	body: JSON.stringify({
		pipeline_id: '65b3db5c8c997c4ce3c4efb3',
		input: {
			provider: 'Minio',
			path: '/input-bucket',
			file_extension: '.txt'
		}, 
		output: {
			provider: 'Dropbox',
			path: '/output-bucket/path/to/folder',
			file_extension: '.xmi'
		},
		settings: {
			minimum_size: 5000, // Bytes
			recursive: true, // Find files recursively in the input bucket.
			check_target: true, // Check the output location for existing files hat won't be processed. 
			sort_by_size: false, // Sort files in ascending order.
			overwrite: false, // Overwrite existing files on conflict.
			ignore_errors: true, // Skips to the next document instead of failing the entire pipeline in case of error.
			worker_count: 4 // The number of threads to use for processing. Limited by the server.
		}
	})
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/processes/65b3dba48c997c4ce3c4f09e', {
	method: 'PUT',
	headers: {
		Authorization: API KEY HERE
	}
})

const response = await fetch('/pipelines/65b3dba48c997c4ce3c4f09e', {
	method: 'DELETE',
	headers: {
		Authorization: API KEY HERE
	}
})